RPC API documentation v34.3.1

Back to Documentation Version:  General How to use RPC Managers AttributesManagerAuditMessagesManagerAuthzResolverCabinetManagerConfigManagerConsentsManagerDatabaseManagerExtSourcesManagerFacilitiesManagerGroupsManagerIntegrationManagerMembersManagerNotificationManagerOwnersManagerRTMessagesManagerRegistrarManagerResourcesManagerSearcherSecurityTeamsManagerServicesManagerTasksManagerUsersManagerVosManager

VosManager

Add user as a manager of VO.

Parameter nameData typeDescription
vointVO id
userintUser id
Thrown exceptionDescription
AlreadyAdminExceptionWhen User is already manager of VO.
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
UserNotExistsExceptionWhen User specified by id doesn't exists.
VoNotExistsExceptionWhen VO specified by id doesn't exists.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/vosManager/addAdmin

Example params

{ "vo" : 63 , "user" : 56 }

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 nameData typeDescription
vointVO id
authorizedGroupintGroup id
Thrown exceptionDescription
AlreadyAdminExceptionWhen Group is already manager of VO.
GroupNotExistsExceptionWhen Group specified by id doesn't exists.
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoNotExistsExceptionWhen VO specified by id doesn't exists.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/vosManager/addAdmin

Example params

{ "vo" : 24 , "authorizedGroup" : 16 }

Example response

null

Adds new relationship between vo and a member vo.

Parameter nameData typeDescription
vointVO id
memberVointVO id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/vosManager/addMemberVo

Example params

{ "vo" : 24 , "memberVo" : 64 }

Example response

null

Add user as a sponsor for guest members of VO.

Parameter nameData typeDescription
vointVO id
userintUser id
Thrown exceptionDescription
AlreadyAdminExceptionWhen User is already sponsor for VO.
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
UserNotExistsExceptionWhen User specified by id doesn't exists.
VoNotExistsExceptionWhen VO specified by id doesn't exists.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/vosManager/addSponsorRole

Example params

{ "vo" : 96 , "user" : 60 }

Example response

null

Add group as a sponsor of guest members of VO. All members of group will become sponsors.

Parameter nameData typeDescription
vointVO id
authorizedGroupintGroup id
Thrown exceptionDescription
AlreadyAdminExceptionWhen Group is already sponsor of VO.
GroupNotExistsExceptionWhen Group specified by id doesn't exists.
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoNotExistsExceptionWhen VO specified by id doesn't exists.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/vosManager/addSponsorRole

Example params

{ "vo" : 1 , "authorizedGroup" : 64 }

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 nameData typeDescription
vointvo id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/vosManager/convertSponsoredUsers

Example params

{ "vo" : 73 }

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 nameData typeDescription
vointvo where members will be converted
newSponsorintuser, who will be set as a sponsor to the sponsored members
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/vosManager/convertSponsoredUsersWithNewSponsor

Example params

{ "vo" : 94 , "newSponsor" : 46 }

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 nameData typeDescription
voVoVO to create (value of VO's id is ignored and will be set internally)
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoExistsExceptionWhen VO you try to create already exists.
Return typeDescription
VoCreated 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. characters.

Parameter nameData typeDescription
nameStringname - length can be no more than 128 characters
shortNameStringshortName - can contain only a-z, A-Z, 0-9, '.', '-', '_' and cannot be longer than 32
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoExistsExceptionWhen VO you try to create already exists.
Return typeDescription
VoCreated 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 nameData typeDescription
vointVO id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RelationExistsExceptionWhen VO has members, groups or resources.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoNotExistsExceptionWhen VO specified by id doesn't exists.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/vosManager/deleteVo

Example params

{ "vo" : 76 }

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 nameData typeDescription
vointVO id
forcebooleanForce must be true
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RelationExistsExceptionWhen VO has members, groups or resources and force == false is set.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoNotExistsExceptionWhen VO specified by id doesn't exists.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/vosManager/deleteVo

Example params

{ "vo" : 84 , "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 nameData typeDescription
vointVO id
searchStringStringText to search by
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoNotExistsExceptionWhen id of VO doesn't match any existing VO.
Return typeDescription
List<Candidate>List of Candidates

Example URL

https://[hostname]/krb/rpc/json/vosManager/findCandidates

Example params

{ "vo" : 76 , "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 nameData typeDescription
vointVO id
searchStringStringText to search by
maxNumOfResultsintNumber of maximum results
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoNotExistsExceptionWhen id of VO doesn't match any existing VO.
Return typeDescription
List<Candidate>List of Candidates

Example URL

https://[hostname]/krb/rpc/json/vosManager/findCandidates

Example params

{ "vo" : 7 , "searchString" : "text" , "maxNumOfResults" : 47 }

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 nameData typeDescription
groupintGroup id
searchStringStringText to search by
Thrown exceptionDescription
GroupNotExistsExceptionWhen id of Group doesn't match any existing Group.
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Candidate>List of Candidates

Example URL

https://[hostname]/krb/rpc/json/vosManager/findCandidates

Example params

{ "group" : 28 , "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 there is no VO group admin.

Parameter nameData typeDescription
vointVO id
roleStringRole name
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Group>List of groups, who are administrators of the VO with supported role. Returns empty list if

Example URL

https://[hostname]/krb/rpc/json/vosManager/getAdminGroups

Example params

{ "vo" : 74 , "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 nameData typeDescription
vointVO id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<User>VO admins

Example URL

https://[hostname]/krb/rpc/json/vosManager/getAdminGroups

Example params

{ "vo" : 11 }

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 nameData typeDescription
vointVO id
roleStringsupported role name
onlyDirectAdminsbooleanif true, get only direct VO administrators (if false, get both direct and indirect)
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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" : 92 , "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 nameData typeDescription
vointVO id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<User>VO admins

Example URL

https://[hostname]/krb/rpc/json/vosManager/getAdmins

Example params

{ "vo" : 67 }

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 exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
banIdintid
Thrown exceptionDescription
BanNotExistsExceptionif there is no such ban
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
PrivilegeExceptioninsufficient permissions
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
BanOnVofound ban

Example URL

https://[hostname]/krb/rpc/json/vosManager/getBanById

Example params

{ "banId" : 76 }

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 nameData typeDescription
memberintmember id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
MemberNotExistsExceptionif there is no member with given id
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
PrivilegeExceptioninsufficient permissions
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
BanOnVofound ban or null if the member is not banned

Example URL

https://[hostname]/krb/rpc/json/vosManager/getBanForMember

Example params

{ "member" : 60 }

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 nameData typeDescription
vointvo id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
PrivilegeExceptioninsufficient permissions
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoNotExistsExceptionif there is no vo with given id
Return typeDescription
List<BanOnVo>vo bans for given vo

Example URL

https://[hostname]/krb/rpc/json/vosManager/getBansForVo

Example params

{ "vo" : 99 }

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 nameData typeDescription
vointVO id
attrNamesList<String>list with names of attributes that should be find.
searchStringStringText to search by
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoNotExistsExceptionWhen id of VO doesn't match any existing VO.
Return typeDescription
List<MemberCandidate>List of MemberCandidates

Example URL

https://[hostname]/krb/rpc/json/vosManager/getCompleteCandidates

Example params

{ "vo" : 43 , "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 nameData typeDescription
groupintGROUP id
attrNamesList<String>list with names of attributes that should be find.
searchStringStringText to search by
Thrown exceptionDescription
GroupNotExistsExceptionWhen id of GROUP doesn't match any existing GROUP.
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<MemberCandidate>List of MemberCandidates

Example URL

https://[hostname]/krb/rpc/json/vosManager/getCompleteCandidates

Example params

{ "group" : 58 , "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 nameData typeDescription
vointVO id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<User>VO admins

Example URL

https://[hostname]/krb/rpc/json/vosManager/getDirectAdmins

Example params

{ "vo" : 67 }

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 nameData typeDescription
vointVO id
specificAttributesList<String>list of attributes URNs
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<RichUser>VO rich admins with attributes

Example URL

https://[hostname]/krb/rpc/json/vosManager/getDirectRichAdminsWithSpecificAttributes

Example params

{ "vo" : 59 , "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 nameData typeDescription
userintuser id
attrNamesList<String>list of attributes names, if null or empty, returns all attributes
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
PrivilegeExceptioninsufficient permissions
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
UserNotExistsExceptionif there is no user with given id
Return typeDescription
List<BanOnVo>vo bans for given user

Example URL

https://[hostname]/krb/rpc/json/vosManager/getEnrichedBansForUser

Example params

{ "user" : 81 , "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 nameData typeDescription
vointvo id
attrNamesList<String>list of attributes names, if null or empty, returns all attributes
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
PrivilegeExceptioninsufficient permissions
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoNotExistsExceptionif there is no vo with given id
Return typeDescription
List<BanOnVo>vo bans for given vo

Example URL

https://[hostname]/krb/rpc/json/vosManager/getEnrichedBansForVo

Example params

{ "vo" : 72 , "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 nameData typeDescription
idintVO id.
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoNotExistsExceptionWhen VO specified by id doesn't exists.
Return typeDescription
EnrichedVoEnrichedVo object of found VO

Example URL

https://[hostname]/krb/rpc/json/vosManager/getEnrichedVoById

Example params

{ "id" : 42 }

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 nameData typeDescription
vointVO id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/vosManager/getMemberVos

Example params

{ "vo" : 38 }

Example response

null

Gets all organizations where given vo is direct member.

Parameter nameData typeDescription
vointVO id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/vosManager/getParentVos

Example params

{ "vo" : 51 }

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. specificAttributes (if false, get only specific attributes) indirect)

Parameter nameData typeDescription
vointVO Id
roleStringrole name
specificAttributesList<String>list of specified attributes which are needed in object richUser
allUserAttributesbooleanif == true, get all possible user attributes and ignore list of
onlyDirectAdminsbooleanif == true, get only direct vo administrators (if false, get both direct and
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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" : 32 , "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 nameData typeDescription
vointVO id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<RichUser>VO admins

Example URL

https://[hostname]/krb/rpc/json/vosManager/getRichAdmins

Example params

{ "vo" : 12 }

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 nameData typeDescription
vointVO id
specificAttributesList<String>list of attributes URNs
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<RichUser>VO rich admins with attributes

Example URL

https://[hostname]/krb/rpc/json/vosManager/getRichAdminsWithSpecificAttributes

Example params

{ "vo" : 41 , "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 nameData typeDescription
idintVO id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoNotExistsExceptionWhen VO specified by id doesn't exists.
Return typeDescription
VoFound VO

Example URL

https://[hostname]/krb/rpc/json/vosManager/getVoById

Example params

{ "id" : 80 }

Example response

{ "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" }

Returns a VO by its short name.

Parameter nameData typeDescription
shortNameStringVO shortName
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoNotExistsExceptionWhen VO specified by short name doesn't exists.
Return typeDescription
VoFound 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 nameData typeDescription
vointVO id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoNotExistsExceptionWhen the vo does not exist.
Return typeDescription
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" : 89 }

Example response

{ ... TODO ... }

Return list of VOs caller has relation with (is manager of VO, is manager of group in VO etc.).

Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
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 nameData typeDescription
idsList<Integer>list of VOs IDs
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Vo>VOs with specified IDs

Example URL

https://[hostname]/krb/rpc/json/vosManager/getVosByIds

Example params

{ "ids" : [ 65 , 53 ] }

Example response

[ { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , {...} , {...} ]

Gets count of all vos.

Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
intvos count

Example URL

https://[hostname]/krb/rpc/json/vosManager/getVosCount

Example response

78

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 nameData typeDescription
vointVO id
userintUser id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
UserNotAdminExceptionWhen User is not manager of VO.
UserNotExistsExceptionWhen User specified by id doesn't exists.
VoNotExistsExceptionWhen VO specified by id doesn't exists.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/vosManager/removeAdmin

Example params

{ "vo" : 34 , "user" : 87 }

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 nameData typeDescription
vointVO id
authorizedGroupintGroup id
Thrown exceptionDescription
GroupNotAdminExceptionWhen Group is not manager of VO.
GroupNotExistsExceptionWhen Group specified by id doesn't exists.
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoNotExistsExceptionWhen VO specified by id doesn't exists.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/vosManager/removeAdmin

Example params

{ "vo" : 59 , "authorizedGroup" : 39 }

Example response

null

Remove vo ban with given id.

Parameter nameData typeDescription
banIdintof vo ban
Thrown exceptionDescription
BanNotExistsExceptionif there is no ban with specified id
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
PrivilegeExceptioninsufficient permissions
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/vosManager/removeBan

Example params

{ "banId" : 18 }

Example response

null

Remove vo ban for member with given id.

Parameter nameData typeDescription
memberintmember id
Thrown exceptionDescription
BanNotExistsExceptionif there is no ban for member with given id
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
PrivilegeExceptioninsufficient permissions
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/vosManager/removeBanForMember

Example params

{ "member" : 4 }

Example response

null

Removes member vo from given vo.

Parameter nameData typeDescription
vointVO id
memberVointVO id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/vosManager/removeMemberVo

Example params

{ "vo" : 97 , "memberVo" : 60 }

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 nameData typeDescription
vointVO id
userintUser id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
UserNotAdminExceptionWhen User is not sponsor
UserNotExistsExceptionWhen User specified by id doesn't exists.
VoNotExistsExceptionWhen VO specified by id doesn't exists.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/vosManager/removeSponsorRole

Example params

{ "vo" : 21 , "user" : 60 }

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 nameData typeDescription
vointVO id
authorizedGroupintGroup id
Thrown exceptionDescription
GroupNotAdminExceptionWhen Group is not manager of VO.
GroupNotExistsExceptionWhen Group specified by id doesn't exists.
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoNotExistsExceptionWhen VO specified by id doesn't exists.
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/vosManager/removeSponsorRole

Example params

{ "vo" : 63 , "authorizedGroup" : 10 }

Example response

null

Set ban for member on his vo. The member id is required, validityTo and description are optional. voId is ignored.

Parameter nameData typeDescription
banOnVoBanOnVoJSON object
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
BanOnVoCreated 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 nameData typeDescription
banOnVoBanOnVoJSON object
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
BanOnVoupdated 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 nameData typeDescription
voVoVO to update with modified params
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoNotExistsExceptionWhen VO specified by id doesn't exists.
Return typeDescription
VoUpdated 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" }