Add user as a manager of VO.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
user | int | User id |
Thrown exception | Description |
---|---|
AlreadyAdminException | When User is already manager of VO. |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
UserNotExistsException | When User specified by id doesn't exists. |
VoNotExistsException | When VO specified by id doesn't exists. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/vosManager/addAdmin
Example params
{ "vo" : 62 , "user" : 33 }
Example response
null
Add group as a manager of VO. All members of group will become VO managers. It means, that who can manage group will also control VO managers (by managing group membership).
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
authorizedGroup | int | Group id |
Thrown exception | Description |
---|---|
AlreadyAdminException | When Group is already manager of VO. |
GroupNotExistsException | When Group specified by id doesn't exists. |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When VO specified by id doesn't exists. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/vosManager/addAdmin
Example params
{ "vo" : 85 , "authorizedGroup" : 96 }
Example response
null
Adds new relationship between vo and a member vo.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
memberVo | int | VO id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/vosManager/addMemberVo
Example params
{ "vo" : 52 , "memberVo" : 52 }
Example response
null
Add user as a sponsor for guest members of VO.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
user | int | User id |
Thrown exception | Description |
---|---|
AlreadyAdminException | When User is already sponsor for VO. |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
UserNotExistsException | When User specified by id doesn't exists. |
VoNotExistsException | When VO specified by id doesn't exists. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/vosManager/addSponsorRole
Example params
{ "vo" : 33 , "user" : 4 }
Example response
null
Add group as a sponsor of guest members of VO. All members of group will become sponsors.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
authorizedGroup | int | Group id |
Thrown exception | Description |
---|---|
AlreadyAdminException | When Group is already sponsor of VO. |
GroupNotExistsException | When Group specified by id doesn't exists. |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When VO specified by id doesn't exists. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/vosManager/addSponsorRole
Example params
{ "vo" : 58 , "authorizedGroup" : 47 }
Example response
null
For the given vo, creates sponsored members for each sponsored user who is a member of the given vo. Original sponsors of the users will be set to the sponsored members.
Parameter name | Data type | Description |
---|---|---|
vo | int | vo id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/vosManager/convertSponsoredUsers
Example params
{ "vo" : 30 }
Example response
null
For the given vo, creates sponsored members for each sponsored user who is a member of the given vo. The sponsored members will be sponsored by the given user, not by its original sponsors.
Parameter name | Data type | Description |
---|---|---|
vo | int | vo where members will be converted |
newSponsor | int | user, who will be set as a sponsor to the sponsored members |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/vosManager/convertSponsoredUsersWithNewSponsor
Example params
{ "vo" : 33 , "newSponsor" : 49 }
Example response
null
Creates new VO. Caller is automatically set as VO manager. Vo Object must contain: name - lenght can be no more than 128 characters shortName - can contain only a-z, A-Z, 0-9, '.', '-', '_' and cannot be longer than 32 characters. Other parameters are ignored.
Parameter name | Data type | Description |
---|---|---|
vo | Vo | VO to create (value of VO's id is ignored and will be set internally) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoExistsException | When VO you try to create already exists. |
Return type | Description |
---|---|
Vo | Created VO with correct id set |
Example URL
https://[hostname]/krb/rpc/json/vosManager/createVo
Example params
{ "vo" : { "name" : "My testing VO" , "shortName" : "test_vo" } }
Example response
{ "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" }
Creates new VO. Caller is automatically set as VO manager.
Parameter name | Data type | Description |
---|---|---|
name | String | name - length can be no more than 128 characters |
shortName | String | shortName - can contain only a-z, A-Z, 0-9, '.', '-', '_' and cannot be longer than 32 characters. |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoExistsException | When VO you try to create already exists. |
Return type | Description |
---|---|
Vo | Created VO with correct id set |
Example URL
https://[hostname]/krb/rpc/json/vosManager/createVo
Example params
{ "name" : "My testing VO" , "shortName" : "test_vo" }
Example response
{ "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" }
Deletes a VO. If VO contain members, group or resources, it's not deleted and exception is thrown.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RelationExistsException | When VO has members, groups or resources. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When VO specified by id doesn't exists. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/vosManager/deleteVo
Example params
{ "vo" : 32 }
Example response
null
Deletes a VO. If force == true
then VO is deleted including members, groups and resources. Otherwise only empty VO is deleted or exception is thrown.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
force | boolean | Force must be true |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RelationExistsException | When VO has members, groups or resources and force == false is set. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When VO specified by id doesn't exists. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/vosManager/deleteVo
Example params
{ "vo" : 88 , "force" : true }
Example response
null
Find candidates for VO. Candidates can be used to create new members. Candidates are searched in VOs external sources (if available). Candidates, which are already members of VO are never returned even if they match searchString.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
searchString | String | Text to search by |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When id of VO doesn't match any existing VO. |
Return type | Description |
---|---|
List<Candidate> | List of Candidates |
Example URL
https://[hostname]/krb/rpc/json/vosManager/findCandidates
Example params
{ "vo" : 80 , "searchString" : "text" }
Example response
[ { "id" : 0 , "serviceUser" : false , "firstName" : "Random" , "lastName" : "Name" , "middleName" : null , "titleBefore" : "Dr." , "titleAfter" : null , userExtSource : { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , additionalUserExtSources : null , attributes : { "urn:perun:member:attribute-def:def:organization" : "Masarykova univerzita" , "urn:perun:member:attribute-def:def:mail" : "random@name.cz" } } , {...} , {...} ]
Find candidates for VO with specified maximum number of results. Candidates can be used to create new members. Candidates are searched in VOs external sources (if available). Candidates, which are already members of VO are never returned even if they match searchString.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
searchString | String | Text to search by |
maxNumOfResults | int | Number of maximum results |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When id of VO doesn't match any existing VO. |
Return type | Description |
---|---|
List<Candidate> | List of Candidates |
Example URL
https://[hostname]/krb/rpc/json/vosManager/findCandidates
Example params
{ "vo" : 78 , "searchString" : "text" , "maxNumOfResults" : 46 }
Example response
[ { "id" : 0 , "serviceUser" : false , "firstName" : "Random" , "lastName" : "Name" , "middleName" : null , "titleBefore" : "Dr." , "titleAfter" : null , userExtSource : { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , additionalUserExtSources : null , attributes : { "urn:perun:member:attribute-def:def:organization" : "Masarykova univerzita" , "urn:perun:member:attribute-def:def:mail" : "random@name.cz" } } , {...} , {...} ]
Find candidates for Group. Candidates can be used to create new VO and Group members. Candidates are searched in Groups external sources (if available). Candidates, which are already members of VO are never returned even if they match searchString.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
searchString | String | Text to search by |
Thrown exception | Description |
---|---|
GroupNotExistsException | When id of Group doesn't match any existing Group. |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Candidate> | List of Candidates |
Example URL
https://[hostname]/krb/rpc/json/vosManager/findCandidates
Example params
{ "group" : 73 , "searchString" : "text" }
Example response
[ { "id" : 0 , "serviceUser" : false , "firstName" : "Random" , "lastName" : "Name" , "middleName" : null , "titleBefore" : "Dr." , "titleAfter" : null , userExtSource : { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , additionalUserExtSources : null , attributes : { "urn:perun:member:attribute-def:def:organization" : "Masarykova univerzita" , "urn:perun:member:attribute-def:def:mail" : "random@name.cz" } } , {...} , {...} ]
Get list of administrator groups of the given VO. Supported roles: VOOBSERVER, TOPGROUPCREATOR, VOADMIN, SPONSOR
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
role | String | Role name |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Group> | List of groups, who are administrators of the VO with supported role. Returns empty list if there is no VO group admin. |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getAdminGroups
Example params
{ "vo" : 27 , "role" : "text" }
Example response
[ { "id" : 1061 , "name" : "My group" , "shortName" : "My group" , "description" : "My testing group" , "parentGroupId" : null , "voId" : 201 , "uuid" : "31e1014b-e994-4cb2-b238-e32aeef87670" , "beanName" : "Group" } , {...} , {...} ]
Returns group administrators of a VO.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<User> | VO admins |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getAdminGroups
Example params
{ "vo" : 88 }
Example response
[ { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" } , {...} , {...} ]
Get list of all vo administrators for supported role and specific vo. If some group is administrator of the VO, all VALID members are included in the list. If onlyDirectAdmins is true, return only direct admins of the vo for supported role. Supported roles: VOOBSERVER, TOPGROUPCREATOR, VOADMIN
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
role | String | supported role name |
onlyDirectAdmins | boolean | if true, get only direct VO administrators (if false, get both direct and indirect) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<User> | list of all user administrators of the given vo for supported role |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getAdmins
Example params
{ "vo" : 57 , "role" : "text" , "onlyDirectAdmins" : true }
Example response
[ { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" } , {...} , {...} ]
Returns administrators of a VO.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<User> | VO admins |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getAdmins
Example params
{ "vo" : 65 }
Example response
[ { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" } , {...} , {...} ]
Return list of all VOs in Perun.
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Vo> | Found VOs |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getAllVos
Example response
[ { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , {...} , {...} ]
Get vo ban with given id.
Parameter name | Data type | Description |
---|---|---|
banId | int | id |
Thrown exception | Description |
---|---|
BanNotExistsException | if there is no such ban |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
PrivilegeException | insufficient permissions |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
BanOnVo | found ban |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getBanById
Example params
{ "banId" : 63 }
Example response
{ "id" : 2 , "validityTo" : 1533638919 , "description" : "banned" , "memberId" : 13541 , "voId" : 12 , "beanName" : "BanOnVo" }
Get ban for given member, or null if he is not banned.
Parameter name | Data type | Description |
---|---|---|
member | int | member id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | if there is no member with given id |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
PrivilegeException | insufficient permissions |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
BanOnVo | found ban or null if the member is not banned |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getBanForMember
Example params
{ "member" : 55 }
Example response
{ "id" : 2 , "validityTo" : 1533638919 , "description" : "banned" , "memberId" : 13541 , "voId" : 12 , "beanName" : "BanOnVo" }
Get list of all bans for vo with given id.
Parameter name | Data type | Description |
---|---|---|
vo | int | vo id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
PrivilegeException | insufficient permissions |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | if there is no vo with given id |
Return type | Description |
---|---|
List<BanOnVo> | vo bans for given vo |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getBansForVo
Example params
{ "vo" : 73 }
Example response
[ { "id" : 2 , "validityTo" : 1533638919 , "description" : "banned" , "memberId" : 13541 , "voId" : 12 , "beanName" : "BanOnVo" } , {...} , {...} ]
Find MemberCandidates for VO. MemberCandidates can be used to create new members. They are made of Candidate, RichUser and Member objects. Candidates are searched in VO's external sources (if available). RichUsers are searched in given VO and are associated with appropriate candidate and member. RichUsers for MemberCandidates may also be searched in the whole Perun.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
attrNames | List<String> | list with names of attributes that should be find. |
searchString | String | Text to search by |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When id of VO doesn't match any existing VO. |
Return type | Description |
---|---|
List<MemberCandidate> | List of MemberCandidates |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getCompleteCandidates
Example params
{ "vo" : 60 , "attrNames" : [ "text" , "text" ] , "searchString" : "text" }
Example response
[ { "candidate" : { "id" : 0 , "serviceUser" : false , "firstName" : "Random" , "lastName" : "Name" , "middleName" : null , "titleBefore" : "Dr." , "titleAfter" : null , userExtSource : { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , additionalUserExtSources : null , attributes : { "urn:perun:member:attribute-def:def:organization" : "Masarykova univerzita" , "urn:perun:member:attribute-def:def:mail" : "random@name.cz" } } , "member" : { "id" : 12 , "userId" : 34 , "voId" : 42 , "sourceGroupId" : null , "membershipType" : "DIRECT" , "status" : "VALID" , "sponsored" : false , "beanName" : "Member" } , "richUser" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "RichUser" , "userExtSources" : [ { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , {...} , {...} ], "userAttributes" : [ { "value" : "my_login" , "type" : "java.lang.String" , "entity" : "user" , "namespace" : "urn:perun:user:attribute-def:def" , "friendlyName" : "login-namespace:perun" , "writable" : true , "baseFriendlyName" : "login-namespace" , "friendlyNameParameter" : "perun" , "unique" : false , "displayName" : "Login in namespace: perun" , "description" : "Logname in namespace 'perun'." , "id" : 1905 , "beanName" : "Attribute" } ] } } , {...} , {...} ]
Find MemberCandidates for GROUP. MemberCandidates can be used to create new members. They are made of Candidate, RichUser and Member objects. Candidates are searched in VO's or GROUP's (depends on privileges) external sources (if available). RichUsers are searched in given VO and are associated with appropriate candidate and member. RichUsers for appropriate Candidate are also searched in the whole Perun.
Parameter name | Data type | Description |
---|---|---|
group | int | GROUP id |
attrNames | List<String> | list with names of attributes that should be find. |
searchString | String | Text to search by |
Thrown exception | Description |
---|---|
GroupNotExistsException | When id of GROUP doesn't match any existing GROUP. |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<MemberCandidate> | List of MemberCandidates |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getCompleteCandidates
Example params
{ "group" : 59 , "attrNames" : [ "text" , "text" ] , "searchString" : "text" }
Example response
[ { "candidate" : { "id" : 0 , "serviceUser" : false , "firstName" : "Random" , "lastName" : "Name" , "middleName" : null , "titleBefore" : "Dr." , "titleAfter" : null , userExtSource : { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , additionalUserExtSources : null , attributes : { "urn:perun:member:attribute-def:def:organization" : "Masarykova univerzita" , "urn:perun:member:attribute-def:def:mail" : "random@name.cz" } } , "member" : { "id" : 12 , "userId" : 34 , "voId" : 42 , "sourceGroupId" : null , "membershipType" : "DIRECT" , "status" : "VALID" , "sponsored" : false , "beanName" : "Member" } , "richUser" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "RichUser" , "userExtSources" : [ { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , {...} , {...} ], "userAttributes" : [ { "value" : "my_login" , "type" : "java.lang.String" , "entity" : "user" , "namespace" : "urn:perun:user:attribute-def:def" , "friendlyName" : "login-namespace:perun" , "writable" : true , "baseFriendlyName" : "login-namespace" , "friendlyNameParameter" : "perun" , "unique" : false , "displayName" : "Login in namespace: perun" , "description" : "Logname in namespace 'perun'." , "id" : 1905 , "beanName" : "Attribute" } ] } } , {...} , {...} ]
Returns direct administrators of a VO.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<User> | VO admins |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getDirectAdmins
Example params
{ "vo" : 69 }
Example response
[ { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" } , {...} , {...} ]
Returns administrators of a VO, which are directly assigned with additional information.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
specificAttributes | List<String> | list of attributes URNs |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichUser> | VO rich admins with attributes |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getDirectRichAdminsWithSpecificAttributes
Example params
{ "vo" : 31 , "specificAttributes" : [ "text" , "text" ] }
Example response
[ { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "RichUser" , "userExtSources" : [ { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , {...} , {...} ], "userAttributes" : [ { "value" : "my_login" , "type" : "java.lang.String" , "entity" : "user" , "namespace" : "urn:perun:user:attribute-def:def" , "friendlyName" : "login-namespace:perun" , "writable" : true , "baseFriendlyName" : "login-namespace" , "friendlyNameParameter" : "perun" , "unique" : false , "displayName" : "Login in namespace: perun" , "description" : "Logname in namespace 'perun'." , "id" : 1905 , "beanName" : "Attribute" } ] } , {...} , {...} ]
Get list of all EnrichedBans for User.
Parameter name | Data type | Description |
---|---|---|
user | int | user id |
attrNames | List<String> | list of attributes names, if null or empty, returns all attributes |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
PrivilegeException | insufficient permissions |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
UserNotExistsException | if there is no user with given id |
Return type | Description |
---|---|
List<BanOnVo> | vo bans for given user |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getEnrichedBansForUser
Example params
{ "user" : 8 , "attrNames" : [ "text" , "text" ] }
Example response
[ { "id" : 2 , "validityTo" : 1533638919 , "description" : "banned" , "memberId" : 13541 , "voId" : 12 , "beanName" : "BanOnVo" } , {...} , {...} ]
Get list of all EnrichedBans for Vo.
Parameter name | Data type | Description |
---|---|---|
vo | int | vo id |
attrNames | List<String> | list of attributes names, if null or empty, returns all attributes |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
PrivilegeException | insufficient permissions |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | if there is no vo with given id |
Return type | Description |
---|---|
List<BanOnVo> | vo bans for given vo |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getEnrichedBansForVo
Example params
{ "vo" : 27 , "attrNames" : [ "text" , "text" ] }
Example response
[ { "id" : 2 , "validityTo" : 1533638919 , "description" : "banned" , "memberId" : 13541 , "voId" : 12 , "beanName" : "BanOnVo" } , {...} , {...} ]
Returns an EnrichedVo object of a VO by its id
.
Parameter name | Data type | Description |
---|---|---|
id | int | VO id . |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When VO specified by id doesn't exists. |
Return type | Description |
---|---|
EnrichedVo | EnrichedVo object of found VO |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getEnrichedVoById
Example params
{ "id" : 91 }
Example response
{ "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "memberVos" : [ { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , {...} , {...} ] , "parentVos" : [ { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , {...} , {...} ] }
Gets all member organizations of the given vo.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getMemberVos
Example params
{ "vo" : 17 }
Example response
null
Gets all organizations where given vo is direct member.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getParentVos
Example params
{ "vo" : 10 }
Example response
null
Get list of all richUser administrators for the vo and supported role with specific attributes. If some group is administrator of the given group, all VALID members are included in the list. Supported roles: VOOBSERVER, TOPGROUPCREATOR, VOADMIN, SPONSOR If "onlyDirectAdmins" is == true, return only direct admins of the vo for supported role with specific attributes. If "allUserAttributes" is == true, do not specify attributes through list and return them all in objects richUser. Ignoring list of specific attributes.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO Id |
role | String | role name |
specificAttributes | List<String> | list of specified attributes which are needed in object richUser |
allUserAttributes | boolean | if == true, get all possible user attributes and ignore list of specificAttributes (if false, get only specific attributes) |
onlyDirectAdmins | boolean | if == true, get only direct vo administrators (if false, get both direct and indirect) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichUser> | list of RichUser administrators for the vo and supported role with attributes |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getRichAdmins
Example params
{ "vo" : 51 , "role" : "text" , "specificAttributes" : [ "text" , "text" ] , "allUserAttributes" : true , "onlyDirectAdmins" : true }
Example response
[ { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "RichUser" , "userExtSources" : [ { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , {...} , {...} ], "userAttributes" : [ { "value" : "my_login" , "type" : "java.lang.String" , "entity" : "user" , "namespace" : "urn:perun:user:attribute-def:def" , "friendlyName" : "login-namespace:perun" , "writable" : true , "baseFriendlyName" : "login-namespace" , "friendlyNameParameter" : "perun" , "unique" : false , "displayName" : "Login in namespace: perun" , "description" : "Logname in namespace 'perun'." , "id" : 1905 , "beanName" : "Attribute" } ] } , {...} , {...} ]
Returns administrators of a VO.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichUser> | VO admins |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getRichAdmins
Example params
{ "vo" : 2 }
Example response
[ { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "RichUser" , "userExtSources" : [ { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , {...} , {...} ], "userAttributes" : [ { "value" : "my_login" , "type" : "java.lang.String" , "entity" : "user" , "namespace" : "urn:perun:user:attribute-def:def" , "friendlyName" : "login-namespace:perun" , "writable" : true , "baseFriendlyName" : "login-namespace" , "friendlyNameParameter" : "perun" , "unique" : false , "displayName" : "Login in namespace: perun" , "description" : "Logname in namespace 'perun'." , "id" : 1905 , "beanName" : "Attribute" } ] } , {...} , {...} ]
Returns administrators of a VO with additional information.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
specificAttributes | List<String> | list of attributes URNs |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichUser> | VO rich admins with attributes |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getRichAdminsWithSpecificAttributes
Example params
{ "vo" : 19 , "specificAttributes" : [ "text" , "text" ] }
Example response
[ { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "RichUser" , "userExtSources" : [ { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , {...} , {...} ], "userAttributes" : [ { "value" : "my_login" , "type" : "java.lang.String" , "entity" : "user" , "namespace" : "urn:perun:user:attribute-def:def" , "friendlyName" : "login-namespace:perun" , "writable" : true , "baseFriendlyName" : "login-namespace" , "friendlyNameParameter" : "perun" , "unique" : false , "displayName" : "Login in namespace: perun" , "description" : "Logname in namespace 'perun'." , "id" : 1905 , "beanName" : "Attribute" } ] } , {...} , {...} ]
Returns a VO by its id
.
Parameter name | Data type | Description |
---|---|---|
id | int | VO id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When VO specified by id doesn't exists. |
Return type | Description |
---|---|
Vo | Found VO |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getVoById
Example params
{ "id" : 42 }
Example response
{ "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" }
Returns a VO by its short name.
Parameter name | Data type | Description |
---|---|---|
shortName | String | VO shortName |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When VO specified by short name doesn't exists. |
Return type | Description |
---|---|
Vo | Found VO |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getVoByShortName
Example params
{ "shortName" : "text" }
Example response
{ "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" }
Returns number of vo members by their status.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When the vo does not exist. |
Return type | Description |
---|---|
Map<String, | Integer> map of status in vo to number of vo members with the status |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getVoMembersCountsByStatus
Example params
{ "vo" : 45 }
Example response
{ ... TODO ... }
Return list of VOs caller has relation with (is manager of VO, is manager of group in VO etc.).
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Vo> | Found VOs |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getVos
Example response
[ { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , {...} , {...} ]
Returns VOs by their IDs.
Parameter name | Data type | Description |
---|---|---|
ids | List<Integer> | list of VOs IDs |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Vo> | VOs with specified IDs |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getVosByIds
Example params
{ "ids" : [ 1 , 22 ] }
Example response
[ { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , {...} , {...} ]
Gets count of all vos.
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
int | vos count |
Example URL
https://[hostname]/krb/rpc/json/vosManager/getVosCount
Example response
32
Removes user from managers of VO. Please note, that user can keep management rights if they are provided by group membership and group is assigned as manager of VO.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
user | int | User id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
UserNotAdminException | When User is not manager of VO. |
UserNotExistsException | When User specified by id doesn't exists. |
VoNotExistsException | When VO specified by id doesn't exists. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/vosManager/removeAdmin
Example params
{ "vo" : 49 , "user" : 29 }
Example response
null
Removes group from managers of VO. Please note, that users can keep their management rights if they are provided by concrete manager role assignment to selected users.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
authorizedGroup | int | Group id |
Thrown exception | Description |
---|---|
GroupNotAdminException | When Group is not manager of VO. |
GroupNotExistsException | When Group specified by id doesn't exists. |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When VO specified by id doesn't exists. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/vosManager/removeAdmin
Example params
{ "vo" : 2 , "authorizedGroup" : 74 }
Example response
null
Remove vo ban with given id.
Parameter name | Data type | Description |
---|---|---|
banId | int | of vo ban |
Thrown exception | Description |
---|---|
BanNotExistsException | if there is no ban with specified id |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
PrivilegeException | insufficient permissions |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/vosManager/removeBan
Example params
{ "banId" : 64 }
Example response
null
Remove vo ban for member with given id.
Parameter name | Data type | Description |
---|---|---|
member | int | member id |
Thrown exception | Description |
---|---|
BanNotExistsException | if there is no ban for member with given id |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
PrivilegeException | insufficient permissions |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/vosManager/removeBanForMember
Example params
{ "member" : 87 }
Example response
null
Removes member vo from given vo.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
memberVo | int | VO id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/vosManager/removeMemberVo
Example params
{ "vo" : 29 , "memberVo" : 43 }
Example response
null
Removes user as a sponsor. His or her sponsored members will be set as expired if the user was their last sponsor.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
user | int | User id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
UserNotAdminException | When User is not sponsor |
UserNotExistsException | When User specified by id doesn't exists. |
VoNotExistsException | When VO specified by id doesn't exists. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/vosManager/removeSponsorRole
Example params
{ "vo" : 22 , "user" : 14 }
Example response
null
Removes group as a sponsor. All group members will cease to be sponsors, and their sponsored members will be set as expired if the group member was their last sponsor.
Parameter name | Data type | Description |
---|---|---|
vo | int | VO id |
authorizedGroup | int | Group id |
Thrown exception | Description |
---|---|
GroupNotAdminException | When Group is not manager of VO. |
GroupNotExistsException | When Group specified by id doesn't exists. |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When VO specified by id doesn't exists. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/vosManager/removeSponsorRole
Example params
{ "vo" : 76 , "authorizedGroup" : 83 }
Example response
null
Set ban for member on his vo. The member id is required, validityTo and description are optional. voId is ignored.
Parameter name | Data type | Description |
---|---|---|
banOnVo | BanOnVo | JSON object |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
BanOnVo | Created banOnVo |
Example URL
https://[hostname]/krb/rpc/json/vosManager/setBan
Example params
{ "banOnVo" : { "id" : 2 , "validityTo" : 1533638919 , "description" : "banned" , "memberId" : 13541 , "voId" : 12 , "beanName" : "BanOnVo" } }
Example response
{ "id" : 2 , "validityTo" : 1533638919 , "description" : "banned" , "memberId" : 13541 , "voId" : 12 , "beanName" : "BanOnVo" }
Update existing ban (description, validation timestamp)
Parameter name | Data type | Description |
---|---|---|
banOnVo | BanOnVo | JSON object |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
BanOnVo | updated banOnVo |
Example URL
https://[hostname]/krb/rpc/json/vosManager/updateBan
Example params
{ "banOnVo" : { "id" : 2 , "validityTo" : 1533638919 , "description" : "banned" , "memberId" : 13541 , "voId" : 12 , "beanName" : "BanOnVo" } }
Example response
{ "id" : 2 , "validityTo" : 1533638919 , "description" : "banned" , "memberId" : 13541 , "voId" : 12 , "beanName" : "BanOnVo" }
Updates a VO. Only name
parameter is updated. VO to updated is determined by id
parameter of passed VO object.
Parameter name | Data type | Description |
---|---|---|
vo | Vo | VO to update with modified params |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When VO specified by id doesn't exists. |
Return type | Description |
---|---|
Vo | Updated VO |
Example URL
https://[hostname]/krb/rpc/json/vosManager/updateVo
Example params
{ "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } }
Example response
{ "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" }