RPC API documentation v17.2.0

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

GroupsManager

Adds an admin to a group.

Parameter nameData typeDescription
groupintGroup id
userintUser id
Thrown exceptionDescription
AlreadyAdminExceptionWhen user has already been Admin
GroupNotExistsException
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 doesn't exist
Return typeDescription
void

Example URL

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

Example params

{ "group" : 25 , "user" : 24 }

Example response

null

Adds an group admin to a group.

Parameter nameData typeDescription
groupintGroup id
authorizedGroupintGroup id
Thrown exceptionDescription
AlreadyAdminExceptionWhen user has already been the Admin
GroupNotExistsExceptionWhen the group doesn't exist
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/groupsManager/addAdmin

Example params

{ "group" : 7 , "authorizedGroup" : 37 }

Example response

null

Adds a member to a group.

Parameter nameData typeDescription
groupintGroup id
memberintMember 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.
WrongReferenceAttributeValueExceptionWhen the attribute of the reference has illegal value
sAlreadyMemberException When already member
sAttributeNotExistsException When attribute doesn't exist
sExternallyManagedException When the group is externally managed
sGroupNotExistsException When group doesn't exist
sMemberNotExistsException When member doesn't exist
sWrongAttributeAssignmentException Thrown while assigning atribute to wrong entity
sWrongAttributeValueException If any member attribute value, required by resource (on which the group is assigned), is wrong
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/groupsManager/addMember

Example params

{ "group" : 79 , "member" : 82 }

Example response

null

Adds a member to the group. If already a member of a group, the group will be skipped. Non-empty list of groups expected, if empty, no member will be added.

Parameter nameData typeDescription
groupsList<Integer>List of id of groups that the member will be added to id
memberintid of a member that will be added to the groups 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/groupsManager/addMember

Example params

{ "groups" : [ 50 , 33 ] , "member" : 36 }

Example response

null

Adds members to a group. If already a member of the group, the member will be skipped. Non-empty list of members expected, if empty, no member will be added.

Parameter nameData typeDescription
groupintid of the group that the members will be added to id
membersList<Integer>id of members that will be added to the group 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/groupsManager/addMembers

Example params

{ "group" : 25 , "members" : [ 41 , 45 ] }

Example response

null

Sets flag required for including group to parent vo in a vo hierarchy.

Parameter nameData typeDescription
groupidof group
voidof parent vo
Thrown exceptionDescription
GroupNotExistsExceptionif group does not exist
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.
RelationExistsExceptionif group is already allowed to be included to parent vo
RelationNotExistsExceptionif group is not from parent vo's member vos
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoNotExistsExceptionif vo does not exist
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/groupsManager/allowGroupToHierarchicalVo

Example params

{ "group" : {...} , "vo" : {...} }

Example response

null

Returns 1 == true if member in given group can extend membership or if no rules were set for the membershipExpiration Otherwise return 0 == false.

Parameter nameData typeDescription
memberintMember id
Thrown exceptionDescription
GroupNotExistsExceptionIf any group not exists in perun
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
MemberNotExistsExceptionWhen member doesn't exist
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
int1 if true | 0 if false

Example URL

https://[hostname]/krb/rpc/json/groupsManager/canExtendMembershipInGroup

Example params

{ "member" : 12 }

Example response

50

Creates a subgroup of a group. Group object must contain name. Description is optional. Other parameters are ignored.

Parameter nameData typeDescription
parentGroupintParent Group id
groupGroupJSON Group class
Thrown exceptionDescription
GroupExistsExceptionWhen group exists
GroupNotExistsExceptionWhen the group doesn't exist
GroupRelationAlreadyExistsWhen the group relation already exists
GroupRelationNotAllowedWhen the group relation cannot be created, because it's not allowed
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 doesn't exist
Return typeDescription
GroupNewly created group

Example URL

https://[hostname]/krb/rpc/json/groupsManager/createGroup

Example params

{ "parentGroup" : 87 , "group" : { "name" : "My testing Group" } }

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" }

Creates a subgroup of a group.

Parameter nameData typeDescription
parentGroupintParent Group id
nameStringname of a group
descriptionStringdescription of a group
Thrown exceptionDescription
GroupExistsExceptionWhen group exists
GroupNotExistsExceptionWhen the group doesn't exist
GroupRelationAlreadyExistsWhen the group relation already exists
GroupRelationNotAllowedWhen the group relation cannot be created, because it's not allowed
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 doesn't exist
Return typeDescription
GroupNewly created group

Example URL

https://[hostname]/krb/rpc/json/groupsManager/createGroup

Example params

{ "parentGroup" : 1 , "name" : "My testing Group" , "description" : "A description with information" }

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" }

Creates a new top-level group in the specific VO defined by object vo in parameter. Important: voId in object group is ignored. Group object must contain name. Description and parentGroupId are optional. Other parameters are ignored.

Parameter nameData typeDescription
vointParent VO id
groupGroupJSON Group class - parentGroupId must be set to null in order to work
Thrown exceptionDescription
GroupExistsExceptionWhen group exists
GroupNotExistsExceptionWhen the group doesn't exist
GroupRelationAlreadyExistsWhen the group relation already exists
GroupRelationNotAllowedWhen the group relation cannot be created, because it's not allowed
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 doesn't exist
Return typeDescription
GroupNewly created group

Example URL

https://[hostname]/krb/rpc/json/groupsManager/createGroup

Example params

{ "vo" : 1 , "group" : { "name" : "My testing Group" } }

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" }

Creates a new group in the specific VO.

Parameter nameData typeDescription
vointParent VO id
nameStringname of a group
descriptionStringdescription of a group
Thrown exceptionDescription
GroupExistsExceptionWhen group exists
GroupNotExistsExceptionWhen the group doesn't exist
GroupRelationAlreadyExistsWhen the group relation already exists
GroupRelationNotAllowedWhen the group relation cannot be created, because it's not allowed
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 doesn't exist
Return typeDescription
GroupNewly created group

Example URL

https://[hostname]/krb/rpc/json/groupsManager/createGroup

Example params

{ "vo" : 1 , "name" : "My testing Group" , "description" : "A description with information" }

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" }

Create union of two groups, where "operandGroup" is technically set as subgroup of "resultGroup". Members from "operandGroup" are added to "resultGroup" as INDIRECT members. Union is honored also in all group member changing operations.

Parameter nameData typeDescription
resultGroupintid of Group to have included "operandGroup"
operandGroupintid of Group to be included into "resultGroup"
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
GroupRelationAlreadyExistsWhen the group relation already exists
GroupRelationNotAllowedWhen the group relation cannot be created, because it's not allowed
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 groups' VO doesn't exist
WrongAttributeValueExceptionWhen the value of the attribute is illegal or wrong
WrongReferenceAttributeValueExceptionWhen the attribute of the reference has illegal value
Return typeDescription
GroupResult group

Example URL

https://[hostname]/krb/rpc/json/groupsManager/createGroupUnion

Example params

{ "resultGroup" : 51 , "operandGroup" : 43 }

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" }

Delete all groups in a VO.

Parameter nameData typeDescription
vointVO id
Thrown exceptionDescription
GroupAlreadyRemovedExceptionIf there is at least 1 group not affected by deleting from DB
GroupAlreadyRemovedFromResourceExceptionIf there is at least 1 group on resource affected by deleting from DB
GroupRelationCannotBeRemovedWhen the group relation cannot be removed
GroupRelationDoesNotExistWhen the group relation doesn't exist
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 doesn't exist
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/groupsManager/deleteAllGroups

Example params

{ "vo" : 49 }

Example response

null

Deletes a group. Group is not deleted, if contains members or is assigned to any resource.

Parameter nameData typeDescription
groupintGroup id
Thrown exceptionDescription
GroupAlreadyRemovedExceptionWhen the group has already been removed
GroupAlreadyRemovedFromResourceExceptionWhen group has already been removed from the resource
GroupNotExistsExceptionWhen the group doesn't exist
GroupRelationCannotBeRemovedWhen group relation cannot be removed
GroupRelationDoesNotExistWhen group relation does not exist
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 the relation already exists
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/groupsManager/deleteGroup

Example params

{ "group" : 21 }

Example response

null

Forcefully deletes a group (remove all group members, remove group from resources).

Parameter nameData typeDescription
groupintGroup id
forcebooleanIf true use force delete.
Thrown exceptionDescription
GroupAlreadyRemovedExceptionWhen the group has already been removed
GroupAlreadyRemovedFromResourceExceptionWhen group has already been removed from the resource
GroupNotExistsExceptionWhen the group doesn't exist
GroupRelationCannotBeRemovedWhen group relation cannot be removed
GroupRelationDoesNotExistWhen group relation does not exist
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 the relation already exists
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/groupsManager/deleteGroup

Example params

{ "group" : 68 , "force" : true }

Example response

null

Forcefully deletes a list of groups (remove all group members, remove group from resources).

Parameter nameData typeDescription
groupsint[]Array of Group IDs
forceDeletebooleanIf true use force delete.
Thrown exceptionDescription
GroupAlreadyRemovedExceptionIf any groups is already deleted
GroupAlreadyRemovedFromResourceException If any group is already removed from resource
GroupNotExistsExceptionIf any group not exists in perun
GroupRelationCannotBeRemovedWhen the group relation cannot be removed
GroupRelationDoesNotExistIf the relation doesn't exist
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.
RelationExistsExceptionIf group has subgroups or member (forceDelete is false)
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/groupsManager/deleteGroups

Example params

{ "groups" : [ 32 , 98 ] , "forceDelete" : true }

Example response

null

Unsets flag required for including group to parent vo in a vo hierarchy.

Parameter nameData typeDescription
groupidof group
voidof parent vo
Thrown exceptionDescription
GroupNotExistsExceptionif group does not exist
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.
RelationNotExistsExceptionif group is not allowed to be included in parent vo
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoNotExistsExceptionif vo does not exist
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/groupsManager/disallowGroupToHierarchicalVo

Example params

{ "group" : {...} , "vo" : {...} }

Example response

null

Extend member membership in given group using membershipExpirationRules attribute defined in Group.

Parameter nameData typeDescription
memberintMember id
groupintGroup id
Thrown exceptionDescription
ExtendMembershipException
GroupNotExistsExceptionIf any group not exists in perun
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
MemberNotExistsExceptionWhen member doesn't exist
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/groupsManager/extendMembershipInGroup

Example params

{ "member" : 4 , "group" : 43 }

Example response

null

Force synchronization for all subgroups (recursively - whole tree) of the group (useful for group structure)

Parameter nameData typeDescription
groupintGroup id
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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/groupsManager/forceAllSubGroupsSynchronization

Example params

{ "group" : 20 }

Example response

null

Forces group structure synchronization.

Parameter nameData typeDescription
groupintGroup id
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
GroupStructureSynchronizationAlreadyRunningExceptionWhen the group structure synchronization has already been running
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/groupsManager/forceGroupStructureSynchronization

Example params

{ "group" : 74 }

Example response

null

Forces group synchronization.

Parameter nameData typeDescription
groupintGroup id
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
GroupSynchronizationAlreadyRunningExceptionWhen the group synchronization has already been running
GroupSynchronizationNotEnabledExceptionWhen group doesn't have synchronization enabled
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/groupsManager/forceGroupSynchronization

Example params

{ "group" : 38 }

Example response

null

Return all members of the group who are active (valid) in the group. Do not return expired members of the group.

Parameter nameData typeDescription
groupintid of group
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group does not exist
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<Member>list of active (valid) members of the group

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getActiveGroupMembers

Example params

{ "group" : 5 }

Example response

[ { "id" : 12 , "userId" : 34 , "voId" : 42 , "sourceGroupId" : null , "membershipType" : "DIRECT" , "status" : "VALID" , "sponsored" : false , "beanName" : "Member" } , {...} , {...} ]

Returns administrator groups of a group.

Parameter nameData typeDescription
groupintGroup id
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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>admins

Example URL

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

Example params

{ "group" : 12 }

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

Get list of all group administrators for supported role and specific group. If some group is administrator of the given group, all VALID members are included in the list. If onlyDirectAdmins is == true, return only direct admins of the group for supported role. Supported roles: GroupAdmin

Parameter nameData typeDescription
groupintGroup id
onlyDirectAdminsintif == true, get only direct user administrators (if == false, get both direct and indirect)
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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 group administrators of the given group for supported role

Example URL

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

Example params

{ "group" : 93 , "onlyDirectAdmins" : 35 }

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

Parameter nameData typeDescription
groupintGroup id
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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>Group admins

Example URL

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

Example params

{ "group" : 4 }

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 all groups which can be included to VO.

Parameter nameData typeDescription
sessperunsession
vointparent VO 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.
VoNotExistsExceptionif given VO does not exist
Return typeDescription
listof groups allowed to hierarchical VO.

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getAllAllowedGroupsToHierarchicalVo

Example params

{ "sess" : {...} , "vo" : 54 }

Example response

{ ... TODO ... }

Returns groups which can be included to VO from specific member VO.

Parameter nameData typeDescription
sessperunsession
vointparent VO id
memberVointmember VO 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.
VoNotExistsExceptionif given VO does not exist
Return typeDescription
listof groups allowed to hierarchical VO.

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getAllAllowedGroupsToHierarchicalVo

Example params

{ "sess" : {...} , "vo" : 74 , "memberVo" : 2 }

Example response

{ ... TODO ... }

Get all groups from all vos. Returned groups are filtered based on the principal rights.

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>Groups

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getAllGroups

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 all groups in 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.
VoNotExistsExceptionWhen the Vo doesn't exist
Return typeDescription
List<Group>Groups

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getAllGroups

Example params

{ "vo" : 55 }

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 all groups in a VO by a hierarchy. Example: [Group => [Group => [Group => []], Group => []]]

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<Object>Groups with subgroups

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getAllGroupsWithHierarchy

Example params

{ "vo" : 66 }

Example response

{ ... TODO ... }

Returns all groups of specific member including group "members".

Parameter nameData typeDescription
memberintid of member
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
MemberNotExistsExceptionWhen the member doesn't exist
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>Groups of member

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getAllMemberGroups

Example params

{ "member" : 15 }

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

Get all groups with their specified attributes. If the attrNames are null or empty, all group attributes are returned.

Parameter nameData typeDescription
attrNamesList<String>list of attribute names to get
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<RichGroup>list of all groups with specified attributes

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroups

Example params

{ "attrNames" : [ "text" , "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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]

Returns sub-list of all RichGroups, each containing selected attributes, starting at fromIndex (included) and ending at the size of the original list. Example: [1,2,3,4], fromIndex=1 => [2,3,4]

Parameter nameData typeDescription
vointid of vo
fromIndexintbegin index of returned subList, included
attrNamesList<String>if attrNames is null method will return RichGroups containing 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.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoNotExistsExceptionWhen Vo doesn't exist
Return typeDescription
List<RichGroup>RichGroups containing selected attributes

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames

Example params

{ "vo" : 25 , "fromIndex" : 94 , "attrNames" : [ "text" , "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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]

Returns sub-list of all RichGroups, each containing all attributes, starting at fromIndex (included) and ending at the size of the original list. Example: [1,2,3,4], fromIndex=1 => [2,3,4]

Parameter nameData typeDescription
vointid of vo
fromIndexintbegin index of returned subList, included
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 doesn't exist
Return typeDescription
List<RichGroup>RichGroups containing all attributes

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames

Example params

{ "vo" : 51 , "fromIndex" : 22 }

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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]

Returns sub-list of all RichGroups, each containing selected attributes, starting at first index of the original list (included) and ending at the toIndex (included). Example: [1,2,3,4], toIndex=2 => [1,2,3]

Parameter nameData typeDescription
vointid of vo
toIndexintend index of returned subList, included
attrNamesList<String>if attrNames is null method will return RichGroups containing 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.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoNotExistsExceptionWhen Vo doesn't exist
Return typeDescription
List<RichGroup>RichGroups containing selected attributes

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames

Example params

{ "vo" : 36 , "toIndex" : 66 , "attrNames" : [ "text" , "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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]

Returns sub-list of all RichGroups, each containing all attributes, starting at first index of the original list (included) and ending at the toIndex (included). Example: [1,2,3,4], toIndex=2 => [1,2,3]

Parameter nameData typeDescription
vointid of vo
toIndexintend index of returned subList, included
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 doesn't exist
Return typeDescription
List<RichGroup>RichGroups containing all attributes

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames

Example params

{ "vo" : 3 , "toIndex" : 0 }

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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]

Returns sub-list of all RichGroups, each containing selected attributes, starting at fromIndex (included) and ending at the toIndex (included). Example: [1,2,3,4], fromIndex=1, toIndex=2 => [2,3]

Parameter nameData typeDescription
vointid of vo
fromIndexintbegin index of returned subList, included
toIndexintend index of returned subList, included
attrNamesList<String>if attrNames is null method will return RichGroups containing 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.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoNotExistsExceptionWhen Vo doesn't exist
Return typeDescription
List<RichGroup>RichGroups containing selected attributes

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames

Example params

{ "vo" : 97 , "fromIndex" : 52 , "toIndex" : 48 , "attrNames" : [ "text" , "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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]

Returns sub-list of all RichGroups, each containing all attributes, starting at fromIndex (included) and ending at the toIndex (included). Example: [1,2,3,4], fromIndex=1, toIndex=2 => [2,3]

Parameter nameData typeDescription
vointid of vo
fromIndexintbegin index of returned subList, included
toIndexintend index of returned subList, included
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 doesn't exist
Return typeDescription
List<RichGroup>RichGroups containing all attributes

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames

Example params

{ "vo" : 62 , "fromIndex" : 23 , "toIndex" : 43 }

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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]

Returns full list of all RichGroups containing selected attributes.

Parameter nameData typeDescription
vointid of vo
attrNamesList<String>if attrNames is null method will return RichGroups containing 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.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoNotExistsExceptionWhen Vo doesn't exist
Return typeDescription
List<RichGroup>RichGroups containing selected attributes

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames

Example params

{ "vo" : 48 , "attrNames" : [ "text" , "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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]

Returns full list of all RichGroups containing all attributes.

Parameter nameData typeDescription
vointid of vo
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 doesn't exist
Return typeDescription
List<RichGroup>RichGroups containing all attributes

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames

Example params

{ "vo" : 61 }

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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]

Returns all AllRichSubGroups from parent group containing selected attributes (all level subgroups).

Parameter nameData typeDescription
groupintid of group
attrNamesList<String>if attrNames is null method will return RichGroups containing all attributes
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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<RichGroup>RichGroups containing selected attributes

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getAllRichSubGroupsWithAttributesByNames

Example params

{ "group" : 35 , "attrNames" : [ "text" , "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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]

Returns direct administrators of a group.

Parameter nameData typeDescription
groupintGroup id
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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>Group admins

Example URL

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

Example params

{ "group" : 17 }

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 all Group admins, which are assigned directly, as RichUsers with specific attributes (from user namespace)

Parameter nameData typeDescription
groupintGroup 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.
VoNotExistsExceptionWhen the Vo doesn't exist
Return typeDescription
List<RichUser>direct admins with attributes

Example URL

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

Example params

{ "group" : 56 , "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 group by id.

Parameter nameData typeDescription
idintGroup id
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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
GroupFound group

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getGroupById

Example params

{ "id" : 20 }

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 a group by VO and Group name. IMPORTANT: need to use full name of group (ex. 'toplevel:a:b', not the shortname which is in this example 'b')

Parameter nameData typeDescription
vointVO id
nameStringGroup name
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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
GroupFound group

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getGroupByName

Example params

{ "vo" : 68 , "name" : "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 direct members of a group.

Parameter nameData typeDescription
groupintGroup id
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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<Member>Group members

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getGroupDirectMembers

Example params

{ "group" : 7 }

Example response

[ { "id" : 12 , "userId" : 34 , "voId" : 42 , "sourceGroupId" : null , "membershipType" : "DIRECT" , "status" : "VALID" , "sponsored" : false , "beanName" : "Member" } , {...} , {...} ]

Returns direct members of a group. RichMember contains User object.

Parameter nameData typeDescription
groupintGroup id
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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<RichMember>Group members

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getGroupDirectRichMembers

Example params

{ "group" : 37 }

Example response

[ { "id" : 12 , "userId" : 34 , "voId" : 42 , "sourceGroupId" : null , "membershipType" : "DIRECT" , "status" : "VALID" , "sponsored" : false , "beanName" : "RichMember" , "user" : { "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" } , "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" } , {...} , {...} ] , "memberAttributes" : [ ] , "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 member in context of group.

Parameter nameData typeDescription
sessperunsession
groupintGroup id
memberintMember 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
Membermember in context of group

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getGroupMemberById

Example params

{ "sess" : {...} , "group" : 99 , "member" : 33 }

Example response

{ "id" : 12 , "userId" : 34 , "voId" : 42 , "sourceGroupId" : null , "membershipType" : "DIRECT" , "status" : "VALID" , "sponsored" : false , "beanName" : "Member" }

Returns members of a group.

Parameter nameData typeDescription
groupintGroup id
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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<Member>Group members

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getGroupMembers

Example params

{ "group" : 70 }

Example response

[ { "id" : 12 , "userId" : 34 , "voId" : 42 , "sourceGroupId" : null , "membershipType" : "DIRECT" , "status" : "VALID" , "sponsored" : false , "beanName" : "Member" } , {...} , {...} ]

Returns count of group members.

Parameter nameData typeDescription
groupintGroup id
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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
intMembers count

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getGroupMembersCount

Example params

{ "group" : 82 }

Example response

75

Returns counts of group members by their group status.

Parameter nameData typeDescription
groupintGroup id
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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
Map<String,Integer> map of member status in group to count of group members with the status

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getGroupMembersCountsByGroupStatus

Example params

{ "group" : 11 }

Example response

{ ... TODO ... }

Returns counts of group members by their status in VO.

Parameter nameData typeDescription
groupintGroup id
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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
Map<String,Integer> map of member status in VO to count of group members with the status

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getGroupMembersCountsByVoStatus

Example params

{ "group" : 89 }

Example response

{ ... TODO ... }

Returns members of a group. RichMember contains User object.

Parameter nameData typeDescription
groupintGroup id
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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<RichMember>Group members

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getGroupRichMembers

Example params

{ "group" : 9 }

Example response

[ { "id" : 12 , "userId" : 34 , "voId" : 42 , "sourceGroupId" : null , "membershipType" : "DIRECT" , "status" : "VALID" , "sponsored" : false , "beanName" : "RichMember" , "user" : { "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" } , "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" } , {...} , {...} ] , "memberAttributes" : [ ] , "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 list of RichMembers with requested attributes by their member IDs from given group. Skips invalid member IDs (unknown or not members of group). Supports member, member-group (stored in memberAttributes) and user attributes (stored in userAttributes).

Parameter nameData typeDescription
groupintGroup id
membersList<Integer>id of members to be returned
attrNamesList<String>names of 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.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<RichMember>Group members

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getGroupRichMembersByIds

Example params

{ "group" : 60 , "members" : [ 92 , 14 ] , "attrNames" : [ "text" , "text" ] }

Example response

[ { "id" : 12 , "userId" : 34 , "voId" : 42 , "sourceGroupId" : null , "membershipType" : "DIRECT" , "status" : "VALID" , "sponsored" : false , "beanName" : "RichMember" , "user" : { "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" } , "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" } , {...} , {...} ] , "memberAttributes" : [ ] , "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 members of a group. RichMember contains User object and attributes.

Parameter nameData typeDescription
groupintGroup id
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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<RichMember>Group members

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getGroupRichMembersWithAttributes

Example params

{ "group" : 98 }

Example response

[ { "id" : 12 , "userId" : 34 , "voId" : 42 , "sourceGroupId" : null , "membershipType" : "DIRECT" , "status" : "VALID" , "sponsored" : false , "beanName" : "RichMember" , "user" : { "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" } , "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" } , {...} , {...} ] , "memberAttributes" : [ ] , "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" } ] } , {...} , {...} ]

Return all operand groups for specified result groups (all INCLUDED groups). If "reverseDirection" is TRUE than return all result groups for specified operand group (where group is INCLUDED).

Parameter nameData typeDescription
groupintid of Group to get groups in union.
reverseDirectionbooleanFALSE (default) return INCLUDED groups / TRUE = return groups where INCLUDED
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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 in union relation.

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getGroupUnions

Example params

{ "group" : 89 , "reverseDirection" : true }

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 direct descendant groups 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.
VoNotExistsExceptionWhen the Vo doesn't exist
Return typeDescription
List<Group>Children groups

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getGroups

Example params

{ "vo" : 80 }

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 groups by their ids.

Parameter nameData typeDescription
idsList<Integer>list of groups 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<Group>groups with specified IDs

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getGroupsByIds

Example params

{ "ids" : [ 91 , 43 ] }

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 groups count in 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.
VoNotExistsExceptionWhen the Vo doesn't exist
Return typeDescription
intGroups count

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getGroupsCount

Example params

{ "vo" : 50 }

Example response

59

Gets count of all groups.

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
intgroups count

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getGroupsCount

Example response

18

Get page of groups from the given vo. Query parameter specifies offset, page size, sorting order, sorting column and string to search groups by (by default it searches in names, ids, uuids and descriptions), last parameter is optional and by default it finds all groups in vo.

Parameter nameData typeDescription
vointVo id
queryGroupsPageQueryQuery with page information
attrNamesList<String>List of attribute names
Thrown exceptionDescription
GroupNotExistsExceptionif group was not found for given parameters
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
MemberGroupMismatchExceptionif given Member is not in specified group
MemberNotExistsExceptionif member was specified but not found
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.
VoNotExistsExceptionif there is no such vo
Return typeDescription
Paginated<RichGroup>page of requested rich groups

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getGroupsPage

Example params

{ "vo" : 94 , "query" : { "pageSize" : 3 , "offset" : 0 , "order" : "ASCENDING" , "sortColumn" : "ID" , "searchString" : "My group" } , "attrNames" : [ "text" , "text" ] }

Example response

{ "offset" : 0 , "pageSize" : 3 , "totalCount" : 1 , "data" : [ { "id" : 1061 , "name" : "My Group" , "shortName" : "My Group" , "description" : "My testing group" , "parentGroupId" : null , "voId" : 201 , "uuid" : "31e1014b-e994-4cb2-b238-e32aeef87670" , "beanName" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]  }

Returns all member's groups where member is in active state (is valid there) Excluded members group.

Parameter nameData typeDescription
memberintid of member
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
MemberNotExistsExceptionWhen the member doesn't exist
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>Groups where member is in active state (valid)

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getGroupsWhereMemberIsActive

Example params

{ "member" : 42 }

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 all member's groups where member is in inactive state (it is not valid and it is expired there) Excluded members group.

Parameter nameData typeDescription
memberintid of member
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
MemberNotExistsExceptionWhen the member doesn't exist
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>Groups where member is in inactive state (expired)

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getGroupsWhereMemberIsInactive

Example params

{ "member" : 96 }

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

Return all members of the group who are inactive (expired) in the group. Do not return active members of the group.

Parameter nameData typeDescription
groupintid of group
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group does not exist
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<Member>list of inactive (expired) members of the group

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getInactiveGroupMembers

Example params

{ "group" : 48 }

Example response

[ { "id" : 12 , "userId" : 34 , "voId" : 42 , "sourceGroupId" : null , "membershipType" : "DIRECT" , "status" : "VALID" , "sponsored" : false , "beanName" : "Member" } , {...} , {...} ]

Get unique paths of groups via which member is indirectly included to the group. Cuts off after first included group.

Parameter nameData typeDescription
sessperunsession
membermember
groupgroupin which the member is indirectly included
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
listsof groups [CURRENT GROUP -> SUBGROUP -> ... -> MEMBER'S SOURCE GROUP]

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getIndirectMembershipPaths

Example params

{ "sess" : {...} , "member" : {...} , "group" : {...} }

Example response

{ ... TODO ... }

Returns groups for a member.

Parameter nameData typeDescription
memberintMember 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<Group>Groups of the member

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getMemberGroups

Example params

{ "member" : 35 }

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 groups with specific attribute for a member.

Parameter nameData typeDescription
memberintMember id
attributeAttributeattribute object with value
Thrown exceptionDescription
AttributeNotExistsExceptionWhen the attribute doesn't exist
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
MemberNotExistsExceptionWhen the member doesn't exist
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.
WrongAttributeAssignmentExceptionThrown while assigning atribute to wrong entity.
Return typeDescription
List<Group>Groups of the member

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getMemberGroupsByAttribute

Example params

{ "member" : 79 , "attribute" : { "id" : 2820 , "friendlyName" : "createdAt" , "namespace" : "urn:perun:vo:attribute-def:core" , "value" : "2011-05-17 00:50:06.3" , "type" : "java.lang.String" , "entity" : "vo" , "writable" : true , "baseFriendlyName" : "createdAt" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "VO created date" , "description" : "Date when VO was created." , "beanName" : "Attribute" } }

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 sub-list of member's RichGroups, each containing selected attributes, starting at fromIndex (included) and ending at the size of the original list. Example: [1,2,3,4], fromIndex=1 => [2,3,4] "members" group is not included! Supported are attributes from these namespaces: - group - member-group

Parameter nameData typeDescription
memberintid of member
fromIndexintbegin index of returned subList, included
attrNamesList<String>if attrNames is null method will return RichGroups containing all attributes
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
MemberNotExistsExceptionWhen the member doesn't exist
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<RichGroup>RichGroups containing selected attributes

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getMemberRichGroupsWithAttributesByNames

Example params

{ "member" : 83 , "fromIndex" : 98 , "attrNames" : [ "text" , "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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]

Returns sub-list of member's RichGroups, each containing selected attributes, starting at first index of the original list (included) and ending at the toIndex (included). Example: [1,2,3,4], toIndex=2 => [1,2,3] "members" group is not included! Supported are attributes from these namespaces: - group - member-group

Parameter nameData typeDescription
memberintid of member
toIndexintend index of returned subList, included
attrNamesList<String>if attrNames is null method will return RichGroups containing all attributes
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
MemberNotExistsExceptionWhen the member doesn't exist
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<RichGroup>RichGroups containing selected attributes

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getMemberRichGroupsWithAttributesByNames

Example params

{ "member" : 1 , "toIndex" : 23 , "attrNames" : [ "text" , "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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]

Returns sub-list of member's RichGroups, each containing selected attributes, starting at fromIndex (included) and ending at the toIndex (included). Example: [1,2,3,4], fromIndex=1, toIndex=2 => [2,3] "members" group is not included! Supported are attributes from these namespaces: - group - member-group

Parameter nameData typeDescription
memberintid of member
fromIndexintbegin index of returned subList, included
toIndexintend index of returned subList, included
attrNamesList<String>if attrNames is null method will return RichGroups containing all attributes
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
MemberNotExistsExceptionWhen the member doesn't exist
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<RichGroup>RichGroups containing selected attributes

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getMemberRichGroupsWithAttributesByNames

Example params

{ "member" : 11 , "fromIndex" : 33 , "toIndex" : 68 , "attrNames" : [ "text" , "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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]

Returns full list of member's RichGroups containing selected attributes. "members" group is not included! Supported are attributes from these namespaces: - group - member-group

Parameter nameData typeDescription
memberintid of member
attrNamesList<String>if attrNames is null method will return RichGroups containing all attributes
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
MemberNotExistsExceptionWhen the member doesn't exist
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<RichGroup>RichGroups containing selected attributes

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getMemberRichGroupsWithAttributesByNames

Example params

{ "member" : 63 , "attrNames" : [ "text" , "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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]

Returns a parent group of a group.

Parameter nameData typeDescription
groupintChild group id
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
ParentGroupNotExistsExceptionWhen the parent group doesn't exist
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
GroupParent group

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getParentGroup

Example params

{ "group" : 92 }

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 members of a parent group.

Parameter nameData typeDescription
groupintChild group id
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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<Member>Parent group members

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getParentGroupMembers

Example params

{ "group" : 8 }

Example response

[ { "id" : 12 , "userId" : 34 , "voId" : 42 , "sourceGroupId" : null , "membershipType" : "DIRECT" , "status" : "VALID" , "sponsored" : false , "beanName" : "Member" } , {...} , {...} ]

Returns members of a parent group. RichMember contains User object.

Parameter nameData typeDescription
groupintChild group 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<RichMember>Parent group members

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getParentGroupRichMembers

Example params

{ "group" : 60 }

Example response

[ { "id" : 12 , "userId" : 34 , "voId" : 42 , "sourceGroupId" : null , "membershipType" : "DIRECT" , "status" : "VALID" , "sponsored" : false , "beanName" : "RichMember" , "user" : { "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" } , "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" } , {...} , {...} ] , "memberAttributes" : [ ] , "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 members of a parent group. RichMember contains User object and attributes.

Parameter nameData typeDescription
groupintChild group 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<RichMember>Parent group members

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getParentGroupRichMembersWithAttributes

Example params

{ "group" : 53 }

Example response

[ { "id" : 12 , "userId" : 34 , "voId" : 42 , "sourceGroupId" : null , "membershipType" : "DIRECT" , "status" : "VALID" , "sponsored" : false , "beanName" : "RichMember" , "user" : { "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" } , "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" } , {...} , {...} ] , "memberAttributes" : [ ] , "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 richUser administrators for the group 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: GroupAdmin If "onlyDirectAdmins" is == true, return only direct admins of the group 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 nameData typeDescription
groupintGroup id
specificAttributesList<String>list of specified attributes which are needed in object richUser
allUserAttributesintif == true, get all possible user attributes and ignore list of specificAttributes (if false, get only specific attributes)
onlyDirectAdminsintif == true, get only direct group administrators (if false, get both direct and indirect)
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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 group and supported role with attributes

Example URL

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

Example params

{ "group" : 62 , "specificAttributes" : [ "text" , "text" ] , "allUserAttributes" : 49 , "onlyDirectAdmins" : 23 }

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 all Group admins as RichUsers

Parameter nameData typeDescription
groupintGroup id
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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>admins

Example URL

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

Example params

{ "group" : 74 }

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 all Group admins as RichUsers with all their non-null user attributes

Parameter nameData typeDescription
groupintGroup id
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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 the user doesn't exist
Return typeDescription
List<RichUser>admins with attributes

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getRichAdminsWithAttributes

Example params

{ "group" : 43 }

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 all Group admins as RichUsers with specific attributes (from user namespace)

Parameter nameData typeDescription
groupintGroup 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.
VoNotExistsExceptionWhen the Vo doesn't exist
Return typeDescription
List<RichUser>admins with attributes

Example URL

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

Example params

{ "group" : 76 , "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 RichGroup selected by id containing selected attributes

Parameter nameData typeDescription
groupIdintid of group
attrNamesList<String>if attrNames is null method will return RichGroup containing all attributes
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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<RichGroup>RichGroups containing selected attributes

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getRichGroupByIdWithAttributesByNames

Example params

{ "groupId" : 6 , "attrNames" : [ "text" , "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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]

Get list of all richGroups with all attributes assigned to the resource filtered by specific member. Allowed namespaces of attributes are group, group-resource and member-group.

Parameter nameData typeDescription
memberintMember id
resourceintResource id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
MemberNotExistsExceptionWhen the member doesn't exist
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
ResourceNotExistsExceptionWhen the resource doesn't exist
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<RichGroup>groups with all group, group-resource and member-group attributes (non-empty)

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getRichGroupsAssignedToResourceWithAttributesByNames

Example params

{ "member" : 62 , "resource" : 42 }

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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]

Get list of all richGroups with selected attributes assigned to the resource filtered by specific member. Allowed namespaces of attributes are group, group-resource and member-group. You will get only attributes which you are authorized to read. You must specify names of requested attributes by their URNs in attrNames. Empty list means no attributes to return.

Parameter nameData typeDescription
memberintMember id
resourceintResource id
attrNamesList<String>names of attributes
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
MemberNotExistsExceptionWhen the member doesn't exist
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
ResourceNotExistsExceptionWhen the resource doesn't exist
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<RichGroup>groups with attributes

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getRichGroupsAssignedToResourceWithAttributesByNames

Example params

{ "member" : 58 , "resource" : 31 , "attrNames" : [ "text" , "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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]

Get list of all richGroups with all attributes assigned to resource. Allowed namespaces of attributes are group and group-resource.

Parameter nameData typeDescription
resourceintResource id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
MemberNotExistsExceptionWhen the member doesn't exist
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
ResourceNotExistsExceptionWhen the resource doesn't exist
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<RichGroup>groups with all group and group-resource attributes (non-empty)

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getRichGroupsAssignedToResourceWithAttributesByNames

Example params

{ "resource" : 7 }

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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]

Get list of all richGroups with selected attributes assigned to resource. Allowed namespaces of attributes are group and group-resource. You will get only attributes which you are authorized to read. You must specify names of requested attributes by their URNs in attrNames.

Parameter nameData typeDescription
resourceintResource id
attrNamesList<String>names of attributes
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
MemberNotExistsExceptionWhen the member doesn't exist
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
ResourceNotExistsExceptionWhen the resource doesn't exist
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<RichGroup>groups with attributes

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getRichGroupsAssignedToResourceWithAttributesByNames

Example params

{ "resource" : 94 , "attrNames" : [ "text" , "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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]

Returns RichSubGroups from parent group containing selected attributes (only 1 level sub groups).

Parameter nameData typeDescription
groupintid of group
attrNamesList<String>if attrNames is null method will return RichGroups containing all attributes
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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<RichGroup>RichGroups containing selected attributes

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getRichSubGroupsWithAttributesByNames

Example params

{ "group" : 8 , "attrNames" : [ "text" , "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" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]

Returns subgroups of a group.

Parameter nameData typeDescription
parentGroupintGroup id
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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>Child groups

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getSubGroups

Example params

{ "parentGroup" : 51 }

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 subgroups count of a group.

Parameter nameData typeDescription
parentGroupintParent group id
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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
intSubgroups count

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getSubGroupsCount

Example params

{ "parentGroup" : 31 }

Example response

5

Get page of subgroups from the parent group. Query parameter specifies offset, page size, sorting order, sorting column and string to search groups by (by default it searches in names, ids, uuids and descriptions), last parameter is optional and by default it finds all subgroups for the given parent group.

Parameter nameData typeDescription
groupintGroup id
queryGroupsPageQueryQuery with page information
attrNamesList<String>List of attribute names
Thrown exceptionDescription
GroupNotExistsExceptionif there is no such query 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
Paginated<RichGroup>page of requested rich groups

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getSubgroupsPage

Example params

{ "group" : 85 , "query" : { "pageSize" : 3 , "offset" : 0 , "order" : "ASCENDING" , "sortColumn" : "ID" , "searchString" : "My group" } , "attrNames" : [ "text" , "text" ] }

Example response

{ "offset" : 0 , "pageSize" : 3 , "totalCount" : 1 , "data" : [ { "id" : 1061 , "name" : "My Group" , "shortName" : "My Group" , "description" : "My testing group" , "parentGroupId" : null , "voId" : 201 , "uuid" : "31e1014b-e994-4cb2-b238-e32aeef87670" , "beanName" : "RichGroup" , "attributes" : [ { "value" : null , "type" : "java.lang.String" , "entity" : "group" , "namespace" : "urn:perun:group:attribute-def:def" , "friendlyName" : "synchronizationEnabled" , "writable" : true , "baseFriendlyName" : "synchronizationEnabled" , "friendlyNameParameter" : "" , "unique" : false , "displayName" : "Synchronization enabled" , "description" : "Enables group synchronization from external source." , "id" : 103 , "beanName" : "Attribute" } ] } , {...} , {...} ]  }

Returns parent VO of a group.

Parameter nameData typeDescription
groupintGroup id
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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
VoParent VO

Example URL

https://[hostname]/krb/rpc/json/groupsManager/getVo

Example params

{ "group" : 15 }

Example response

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

Returns flag representing if the group can be included in the (parent) vo's groups

Parameter nameData typeDescription
groupidof group
voidof parent vo
Thrown exceptionDescription
GroupNotExistsExceptionif group does not exist
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.
VoNotExistsExceptionif vo does not exist
Return typeDescription
booleantrue if group can be included in vo's groups, false otherwise

Example URL

https://[hostname]/krb/rpc/json/groupsManager/isAllowedGroupToHierarchicalVo

Example params

{ "group" : {...} , "vo" : {...} }

Example response

true

Return true if Member is member of the Group

Parameter nameData typeDescription
groupintGroup ID
memberintMember ID
Thrown exceptionDescription
GroupNotExistsExceptionWhen Group with id doesn't exist.
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
booleanTrue if Member is member of the Group

Example URL

https://[hostname]/krb/rpc/json/groupsManager/isGroupMember

Example params

{ "group" : 77 , "member" : 97 }

Example response

true

Moves "movingGroup" (including subGroups) under "destinationGroup" as subGroup within same Vo. Indirect group members are also processed during move operation.

Parameter nameData typeDescription
destinationGroupintid of Group to have "movingGroup" as subGroup
movingGroupintid of Group to be moved under "destinationGroup"
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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.
WrongAttributeValueExceptionWhen the value of the attribute is illegal or wrong
WrongReferenceAttributeValueExceptionWhen the attribute of the reference has illegal value
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/groupsManager/moveGroup

Example params

{ "destinationGroup" : 81 , "movingGroup" : 72 }

Example response

null

Moves "movingGroup" (including subGroups) from it`s location to top-level. Indirect group members are also processed during move operation.

Parameter nameData typeDescription
movingGroupintid of Group to be moved under "destinationGroup"
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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.
WrongAttributeValueExceptionWhen the value of the attribute is illegal or wrong
WrongReferenceAttributeValueExceptionWhen the attribute of the reference has illegal value
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/groupsManager/moveGroup

Example params

{ "movingGroup" : 2 }

Example response

null

Removes an admin of a group.

Parameter nameData typeDescription
groupintGroup id
userintUser id
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
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 the user is not an admin
UserNotExistsExceptionWhern the user doesn't exist
Return typeDescription
void

Example URL

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

Example params

{ "group" : 16 , "user" : 11 }

Example response

null

Removes a group admin of a group.

Parameter nameData typeDescription
groupintGroup id
authorizedGroupintGroup id
Thrown exceptionDescription
GroupNotAdminException- NO DESCRIPTION
GroupNotExistsExceptionWhen the group doesn't exist
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/groupsManager/removeAdmin

Example params

{ "group" : 74 , "authorizedGroup" : 71 }

Example response

null

Removes union of two groups, when "operandGroup" is technically removed from subgroups of "resultGroup". Members from "operandGroup" are removed from "resultGroup" if they were INDIRECT members sourcing from this group only.

Parameter nameData typeDescription
resultGroupintid of Group to have removed "operandGroup" from subgroups
operandGroupintid of Group to be removed from "resultGroup" subgroups
Thrown exceptionDescription
GroupNotExistsExceptionIf any group not exists in perun
GroupRelationCannotBeRemovedWhen the group relation cannot be removed
GroupRelationDoesNotExistIf the relation doesn't exist
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/groupsManager/removeGroupUnion

Example params

{ "resultGroup" : 82 , "operandGroup" : 3 }

Example response

null

Removes a member from a group.

Parameter nameData typeDescription
groupintGroup id
memberintMember id
Thrown exceptionDescription
AttributeNotExistsExceptionWhen attribute doesn't exist
ExternallyManagedExceptionWhen the group is externally managed
GroupNotExistsExceptionWhen the group doesn't exist
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
MemberNotExistsExceptionWhen member doesn't exist
NotGroupMemberException When member is not in the group
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.
WrongAttributeAssignmentExceptionWhen assigning atribute to wrong entity
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/groupsManager/removeMember

Example params

{ "group" : 66 , "member" : 39 }

Example response

null

Removes a member from groups. If a member is not in the group or is indirect, it is skipped without a warning, but the rest of groups are processed. Non-empty list of groups expected. In case of empty list, member is not removed.

Parameter nameData typeDescription
groupsList<Integer>Group - can be empty id
memberintMember id
Thrown exceptionDescription
AttributeNotExistsExceptionWhen attribute doesn't exist
ExternallyManagedExceptionWhen the group is externally managed
GroupNotExistsExceptionWhen the group doesn't exist
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
MemberNotExistsExceptionWhen member doesn't exist
NotGroupMemberException When member is not in the group
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.
WrongAttributeAssignmentExceptionWhen assigning atribute to wrong entity
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/groupsManager/removeMember

Example params

{ "groups" : [ 35 , 79 ] , "member" : 97 }

Example response

null

Removes members from a group. Non-empty list of members expected. In case of empty list, no member is removed from the group. If member is not in the group or the membership is indirect, it is skipped without a warning but the rest of the members are processed.

Parameter nameData typeDescription
groupintGroup id
membersList<Integer>Members - can be empty id
Thrown exceptionDescription
AttributeNotExistsExceptionWhen attribute doesn't exist
ExternallyManagedExceptionWhen the group is externally managed
GroupNotExistsExceptionWhen the group doesn't exist
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
MemberNotExistsExceptionWhen member doesn't exist
NotGroupMemberException When member is not in the group
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.
WrongAttributeAssignmentExceptionWhen assigning atribute to wrong entity
Return typeDescription
void

Example URL

https://[hostname]/krb/rpc/json/groupsManager/removeMembers

Example params

{ "group" : 7 , "members" : [ 29 , 66 ] }

Example response

null

Set membership status of a member in a group. Please note, that resulting Status after change is calculated from all members sub-groups and groups in relation sourcing this member. If in any of them is VALID, resulting status is still VALID.

Parameter nameData typeDescription
memberintMember id
groupintGroup id
statusStringVALID | EXPIRED
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
MemberMember with status after change

Example URL

https://[hostname]/krb/rpc/json/groupsManager/setGroupsMemberStatus

Example params

{ "member" : 74 , "group" : 6 , "status" : "EXPIRED" }

Example response

{ "id" : 12 , "userId" : 34 , "voId" : 42 , "sourceGroupId" : null , "membershipType" : "DIRECT" , "status" : "VALID" , "sponsored" : false , "beanName" : "Member" }

Updates a group.

Parameter nameData typeDescription
groupGroupJSON Group class
Thrown exceptionDescription
GroupExistsExceptionwhen the group with the same name already exists in the same vo
GroupNotExistsExceptionWhen the group doesn't exist
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
GroupUpdated group

Example URL

https://[hostname]/krb/rpc/json/groupsManager/updateGroup

Example params

{ "group" : { "id" : 1061 , "name" : "My group" , "shortName" : "My group" , "description" : "My testing group" , "parentGroupId" : null , "voId" : 201 , "uuid" : "31e1014b-e994-4cb2-b238-e32aeef87670" , "beanName" : "Group" } }

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" }