RPC API documentation v45.0.0

Add user as a manager of VO.

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

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).

Example URL

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

• see URL structure

Example params

{ "vo" : 7 , "authorizedGroup" : 0 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Adds new relationship between vo and a member vo.

Example URL

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

• see URL structure

Example params

{ "vo" : 65 , "memberVo" : 86 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Add user as a sponsor for guest members of VO.

Example URL

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

• see URL structure

Example params

{ "vo" : 20 , "user" : 88 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

{ "vo" : 42 , "authorizedGroup" : 19 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

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.

Example URL

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

• see URL structure

Example params

{ "vo" : 0 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

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.

Example URL

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

• see URL structure

Example params

{ "vo" : 71 , "newSponsor" : 27 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

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.

Example URL

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

• see URL structure

Example params

{ "vo" : { "name" : "My testing VO" , "shortName" : "test_vo" } }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Creates new VO. Caller is automatically set as VO manager.

Example URL

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

• see URL structure

Example params

{ "name" : "My testing VO" , "shortName" : "test_vo" }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Deletes a VO. If VO contain members, group or resources, it's not deleted and exception is thrown.

Example URL

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

• see URL structure

Example params

{ "vo" : 96 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

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.

Example URL

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

• see URL structure

Example params

{ "vo" : 13 , "force" : true }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

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.

Example URL

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

• see URL structure

Example params

{ "vo" : 25 , "searchString" : "text" }

• see Passing params

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" } } , {...} , {...} ]

• see Return values
• see HTTP return codes

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.

Example URL

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

• see URL structure

Example params

{ "vo" : 86 , "searchString" : "text" , "maxNumOfResults" : 27 }

• see Passing params

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" } } , {...} , {...} ]

• see Return values
• see HTTP return codes

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.

Example URL

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

• see URL structure

Example params

{ "group" : 78 , "searchString" : "text" }

• see Passing params

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" } } , {...} , {...} ]

• see Return values
• see HTTP return codes

Get list of administrator groups of the given VO. Supported roles: VOOBSERVER, TOPGROUPCREATOR, VOADMIN, SPONSOR

Example URL

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

• see URL structure

Example params

{ "vo" : 99 , "role" : "text" }

• see Passing params

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" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Returns group administrators of a VO.

Example URL

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

• see URL structure

Example params

{ "vo" : 87 }

• see Passing params

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" } , {...} , {...} ]

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

{ "vo" : 73 , "role" : "text" , "onlyDirectAdmins" : true }

• see Passing params

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" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Returns administrators of a VO.

Example URL

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

• see URL structure

Example params

{ "vo" : 34 }

• see Passing params

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" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Return list of all VOs in Perun.

Example URL

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

• see URL structure

Example response

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

• see Return values
• see HTTP return codes

Get vo ban with given id.

Example URL

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

• see URL structure

Example params

{ "banId" : 72 }

• see Passing params

Example response

{ "id" : 2 , "validityTo" : 1533638919 , "description" : "banned" , "memberId" : 13541 , "voId" : 12 , "beanName" : "BanOnVo" }

• see Return values
• see HTTP return codes

Get ban for given member, or null if he is not banned.

Example URL

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

• see URL structure

Example params

{ "member" : 64 }

• see Passing params

Example response

{ "id" : 2 , "validityTo" : 1533638919 , "description" : "banned" , "memberId" : 13541 , "voId" : 12 , "beanName" : "BanOnVo" }

• see Return values
• see HTTP return codes

Get list of all bans for vo with given id.

Example URL

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

• see URL structure

Example params

{ "vo" : 97 }

• see Passing params

Example response

[ { "id" : 2 , "validityTo" : 1533638919 , "description" : "banned" , "memberId" : 13541 , "voId" : 12 , "beanName" : "BanOnVo" } , {...} , {...} ]

• see Return values
• see HTTP return codes

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.

Example URL

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

• see URL structure

Example params

{ "vo" : 65 , "attrNames" : [ "text" , "text" ] , "searchString" : "text" }

• see Passing params

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" } ] } } , {...} , {...} ]

• see Return values
• see HTTP return codes

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.

Example URL

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

• see URL structure

Example params

{ "group" : 22 , "attrNames" : [ "text" , "text" ] , "searchString" : "text" }

• see Passing params

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" } ] } } , {...} , {...} ]

• see Return values
• see HTTP return codes

Returns direct administrators of a VO.

Example URL

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

• see URL structure

Example params

{ "vo" : 34 }

• see Passing params

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" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Returns administrators of a VO, which are directly assigned with additional information.

Example URL

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

• see URL structure

Example params

{ "vo" : 12 , "specificAttributes" : [ "text" , "text" ] }

• see Passing params

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" } ] } , {...} , {...} ]

• see Return values
• see HTTP return codes

Get list of all EnrichedBans for User.

Example URL

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

• see URL structure

Example params

{ "user" : 65 , "attrNames" : [ "text" , "text" ] }

• see Passing params

Example response

[ { "id" : 2 , "validityTo" : 1533638919 , "description" : "banned" , "memberId" : 13541 , "voId" : 12 , "beanName" : "BanOnVo" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Get list of all EnrichedBans for Vo.

Example URL

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

• see URL structure

Example params

{ "vo" : 90 , "attrNames" : [ "text" , "text" ] }

• see Passing params

Example response

[ { "id" : 2 , "validityTo" : 1533638919 , "description" : "banned" , "memberId" : 13541 , "voId" : 12 , "beanName" : "BanOnVo" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Returns an EnrichedVo object of a VO by its id.

Example URL

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

• see URL structure

Example params

{ "id" : 11 }

• see Passing params

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" } , {...} , {...} ] }

• see Return values
• see HTTP return codes

Gets all member organizations of the given vo.

Example URL

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

• see URL structure

Example params

{ "vo" : 26 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Gets all organizations where given vo is direct member.

Example URL

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

• see URL structure

Example params

{ "vo" : 43 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

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.

Example URL

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

• see URL structure

Example params

{ "vo" : 39 , "role" : "text" , "specificAttributes" : [ "text" , "text" ] , "allUserAttributes" : true , "onlyDirectAdmins" : true }

• see Passing params

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" } ] } , {...} , {...} ]

• see Return values
• see HTTP return codes

Returns administrators of a VO.

Example URL

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

• see URL structure

Example params

{ "vo" : 32 }

• see Passing params

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" } ] } , {...} , {...} ]

• see Return values
• see HTTP return codes

Returns administrators of a VO with additional information.

Example URL

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

• see URL structure

Example params

{ "vo" : 50 , "specificAttributes" : [ "text" , "text" ] }

• see Passing params

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" } ] } , {...} , {...} ]

• see Return values
• see HTTP return codes

Returns a VO by its id.

Example URL

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

• see URL structure

Example params

{ "id" : 26 }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Returns a VO by its short name.

Example URL

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

• see URL structure

Example params

{ "shortName" : "text" }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Returns number of vo members by their status.

Example URL

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

• see URL structure

Example params

{ "vo" : 79 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example response

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

• see Return values
• see HTTP return codes

Returns VOs by their IDs.

Example URL

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

• see URL structure

Example params

{ "ids" : [ 80 , 22 ] }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Gets count of all vos.

Example URL

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

• see URL structure

Example response

99

• see Return values
• see HTTP return codes

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.

Example URL

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

• see URL structure

Example params

{ "vo" : 90 , "user" : 88 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

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.

Example URL

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

• see URL structure

Example params

{ "vo" : 31 , "authorizedGroup" : 47 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Remove vo ban with given id.

Example URL

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

• see URL structure

Example params

{ "banId" : 53 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Remove vo ban for member with given id.

Example URL

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

• see URL structure

Example params

{ "member" : 60 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Removes member vo from given vo.

Example URL

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

• see URL structure

Example params

{ "vo" : 72 , "memberVo" : 93 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Removes user as a sponsor. His or her sponsored members will be set as expired if the user was their last sponsor.

Example URL

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

• see URL structure

Example params

{ "vo" : 90 , "user" : 16 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

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.

Example URL

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

• see URL structure

Example params

{ "vo" : 72 , "authorizedGroup" : 61 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

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

Example URL

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

• see URL structure

Example params

{ "banOnVo" : { "id" : 2 , "validityTo" : 1533638919 , "description" : "banned" , "memberId" : 13541 , "voId" : 12 , "beanName" : "BanOnVo" } }

• see Passing params

Example response

{ "id" : 2 , "validityTo" : 1533638919 , "description" : "banned" , "memberId" : 13541 , "voId" : 12 , "beanName" : "BanOnVo" }

• see Return values
• see HTTP return codes

Update existing ban (description, validation timestamp)

Example URL

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

• see URL structure

Example params

{ "banOnVo" : { "id" : 2 , "validityTo" : 1533638919 , "description" : "banned" , "memberId" : 13541 , "voId" : 12 , "beanName" : "BanOnVo" } }

• see Passing params

Example response

{ "id" : 2 , "validityTo" : 1533638919 , "description" : "banned" , "memberId" : 13541 , "voId" : 12 , "beanName" : "BanOnVo" }

• see Return values
• see HTTP return codes

Updates a VO. Only name parameter is updated. VO to updated is determined by id parameter of passed VO object.

Example URL

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

• see URL structure

Example params

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

• see Passing params

Example response

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

• see Return values
• see HTTP return codes