Adds an admin to a group.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
user | int | User id |
Thrown exception | Description |
---|---|
AlreadyAdminException | When user has already been Admin |
GroupNotExistsException | |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
UserNotExistsException | When user doesn't exist |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/addAdmin
Example params
{ "group" : 33 , "user" : 88 }
Example response
null
Adds an group admin to a group.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
authorizedGroup | int | Group id |
Thrown exception | Description |
---|---|
AlreadyAdminException | When user has already been the Admin |
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/addAdmin
Example params
{ "group" : 42 , "authorizedGroup" : 38 }
Example response
null
Adds a member to a group.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
member | int | Member id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
WrongReferenceAttributeValueException | When the attribute of the reference has illegal value |
s | AlreadyMemberException When already member |
s | AttributeNotExistsException When attribute doesn't exist |
s | ExternallyManagedException When the group is externally managed |
s | GroupNotExistsException When group doesn't exist |
s | MemberNotExistsException When member doesn't exist |
s | WrongAttributeAssignmentException Thrown while assigning atribute to wrong entity |
s | WrongAttributeValueException If any member attribute value, required by resource (on which the group is assigned), is wrong |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/addMember
Example params
{ "group" : 0 , "member" : 99 }
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 name | Data type | Description |
---|---|---|
groups | List<Integer> | List of id of groups that the member will be added to id |
member | int | id of a member that will be added to the groups id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/addMember
Example params
{ "groups" : [ 50 , 1 ] , "member" : 40 }
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 name | Data type | Description |
---|---|---|
group | int | id of the group that the members will be added to id |
members | List<Integer> | id of members that will be added to the group id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/addMembers
Example params
{ "group" : 55 , "members" : [ 54 , 80 ] }
Example response
null
Sets flag required for including group to parent vo in a vo hierarchy.
Parameter name | Data type | Description |
---|---|---|
group | id | of group |
vo | id | of parent vo |
Thrown exception | Description |
---|---|
GroupNotExistsException | if group does not exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RelationExistsException | if group is already allowed to be included to parent vo |
RelationNotExistsException | if group is not from parent vo's member vos |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | if vo does not exist |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/allowGroupToHierarchicalVo
Example params
{ "group" : {...} , "vo" : {...} }
Example response
null
Sets flag required for including groups to parent vo in a vo hierarchy.
Parameter name | Data type | Description |
---|---|---|
groups | List<Integer> | id of groups |
vo | int | Vo id |
Thrown exception | Description |
---|---|
GroupNotExistsException | if group does not exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RelationExistsException | if group is already allowed to be included to parent vo |
RelationNotExistsException | if group is not from parent vo's member vos |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | if vo does not exist |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/allowGroupsToHierarchicalVo
Example params
{ "groups" : [ 62 , 80 ] , "vo" : 73 }
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 name | Data type | Description |
---|---|---|
member | int | Member id |
Thrown exception | Description |
---|---|
GroupNotExistsException | If any group not exists in perun |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
int | 1 if true | 0 if false |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/canExtendMembershipInGroup
Example params
{ "member" : 0 }
Example response
8
Copies direct members from one group to other groups in the same VO. The members are copied without their member-group attributes. Copies all direct members if members list is empty or null.
Parameter name | Data type | Description |
---|---|---|
sourceGroup | int | id of the group to copy members from |
destinationGroups | List<Integer> | id of groups to copy members to |
members | List<Integer> | id of members that will be copied |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/copyMembers
Example params
{ "sourceGroup" : 18 , "destinationGroups" : [ 59 , 80 ] , "members" : [ 95 , 4 ] }
Example response
null
Creates a subgroup of a group. Group object must contain name. Description is optional. Other parameters are ignored.
Parameter name | Data type | Description |
---|---|---|
parentGroup | int | Parent Group id |
group | Group | JSON Group class |
Thrown exception | Description |
---|---|
GroupExistsException | When group exists |
GroupNotExistsException | When the group doesn't exist |
GroupRelationAlreadyExists | When the group relation already exists |
GroupRelationNotAllowed | When the group relation cannot be created, because it's not allowed |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
Group | Newly created group |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/createGroup
Example params
{ "parentGroup" : 12 , "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 name | Data type | Description |
---|---|---|
parentGroup | int | Parent Group id |
name | String | name of a group |
description | String | description of a group |
Thrown exception | Description |
---|---|
GroupExistsException | When group exists |
GroupNotExistsException | When the group doesn't exist |
GroupRelationAlreadyExists | When the group relation already exists |
GroupRelationNotAllowed | When the group relation cannot be created, because it's not allowed |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
Group | Newly 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 name | Data type | Description |
---|---|---|
vo | int | Parent VO id |
group | Group | JSON Group class - parentGroupId must be set to null in order to work |
Thrown exception | Description |
---|---|
GroupExistsException | When group exists |
GroupNotExistsException | When the group doesn't exist |
GroupRelationAlreadyExists | When the group relation already exists |
GroupRelationNotAllowed | When the group relation cannot be created, because it's not allowed |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
Group | Newly 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 name | Data type | Description |
---|---|---|
vo | int | Parent VO id |
name | String | name of a group |
description | String | description of a group |
Thrown exception | Description |
---|---|
GroupExistsException | When group exists |
GroupNotExistsException | When the group doesn't exist |
GroupRelationAlreadyExists | When the group relation already exists |
GroupRelationNotAllowed | When the group relation cannot be created, because it's not allowed |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
Group | Newly 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 name | Data type | Description |
---|---|---|
resultGroup | int | id of Group to have included "operandGroup" |
operandGroup | int | id of Group to be included into "resultGroup" |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
GroupRelationAlreadyExists | When the group relation already exists |
GroupRelationNotAllowed | When the group relation cannot be created, because it's not allowed |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When the groups' VO doesn't exist |
WrongAttributeValueException | When the value of the attribute is illegal or wrong |
WrongReferenceAttributeValueException | When the attribute of the reference has illegal value |
Return type | Description |
---|---|
Group | Result group |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/createGroupUnion
Example params
{ "resultGroup" : 4 , "operandGroup" : 38 }
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 name | Data type | Description |
---|---|---|
vo | int | VO id |
Thrown exception | Description |
---|---|
GroupAlreadyRemovedException | If there is at least 1 group not affected by deleting from DB |
GroupAlreadyRemovedFromResourceException | If there is at least 1 group on resource affected by deleting from DB |
GroupRelationCannotBeRemoved | When the group relation cannot be removed |
GroupRelationDoesNotExist | When the group relation doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When the Vo doesn't exist |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/deleteAllGroups
Example params
{ "vo" : 63 }
Example response
null
Deletes a group. Group is not deleted, if contains members or is assigned to any resource.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
Thrown exception | Description |
---|---|
GroupAlreadyRemovedException | When the group has already been removed |
GroupAlreadyRemovedFromResourceException | When group has already been removed from the resource |
GroupNotExistsException | When the group doesn't exist |
GroupRelationCannotBeRemoved | When group relation cannot be removed |
GroupRelationDoesNotExist | When group relation does not exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RelationExistsException | When the relation already exists |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/deleteGroup
Example params
{ "group" : 65 }
Example response
null
Forcefully deletes a group (remove all group members, remove group from resources).
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
force | boolean | If true use force delete. |
Thrown exception | Description |
---|---|
GroupAlreadyRemovedException | When the group has already been removed |
GroupAlreadyRemovedFromResourceException | When group has already been removed from the resource |
GroupNotExistsException | When the group doesn't exist |
GroupRelationCannotBeRemoved | When group relation cannot be removed |
GroupRelationDoesNotExist | When group relation does not exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RelationExistsException | When the relation already exists |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/deleteGroup
Example params
{ "group" : 69 , "force" : true }
Example response
null
Forcefully deletes a list of groups (remove all group members, remove group from resources).
Parameter name | Data type | Description |
---|---|---|
groups | int[] | Array of Group IDs |
forceDelete | boolean | If true use force delete. |
Thrown exception | Description |
---|---|
GroupAlreadyRemovedException | If any groups is already deleted |
GroupAlreadyRemovedFromResourceException | If any group is already removed from resource |
GroupNotExistsException | If any group not exists in perun |
GroupRelationCannotBeRemoved | When the group relation cannot be removed |
GroupRelationDoesNotExist | If the relation doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RelationExistsException | If group has subgroups or member (forceDelete is false) |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/deleteGroups
Example params
{ "groups" : [ 55 , 91 ] , "forceDelete" : true }
Example response
null
Unsets flag required for including group to parent vo in a vo hierarchy.
Parameter name | Data type | Description |
---|---|---|
group | id | of group |
vo | id | of parent vo |
Thrown exception | Description |
---|---|
GroupNotExistsException | if group does not exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RelationNotExistsException | if group is not allowed to be included in parent vo |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | if vo does not exist |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/disallowGroupToHierarchicalVo
Example params
{ "group" : {...} , "vo" : {...} }
Example response
null
Unsets flag required for including groups to parent vo in a vo hierarchy.
Parameter name | Data type | Description |
---|---|---|
groups | List<Integer> | id of groups |
vo | int | VO id |
Thrown exception | Description |
---|---|
GroupNotExistsException | if group does not exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RelationNotExistsException | if group is not allowed to be included in parent vo |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | if vo does not exist |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/disallowGroupsToHierarchicalVo
Example params
{ "groups" : [ 62 , 98 ] , "vo" : 18 }
Example response
null
Extend member membership in given group using membershipExpirationRules attribute defined in Group.
Parameter name | Data type | Description |
---|---|---|
member | int | Member id |
group | int | Group id |
Thrown exception | Description |
---|---|
ExtendMembershipException | |
GroupNotExistsException | If any group not exists in perun |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/extendMembershipInGroup
Example params
{ "member" : 36 , "group" : 20 }
Example response
null
Force synchronization for all subgroups (recursively - whole tree) of the group (useful for group structure)
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/forceAllSubGroupsSynchronization
Example params
{ "group" : 63 }
Example response
null
Forces group structure synchronization.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
GroupStructureSynchronizationAlreadyRunningException | When the group structure synchronization has already been running |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/forceGroupStructureSynchronization
Example params
{ "group" : 47 }
Example response
null
Forces group synchronization.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
GroupSynchronizationAlreadyRunningException | When the group synchronization has already been running |
GroupSynchronizationNotEnabledException | When group doesn't have synchronization enabled |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/forceGroupSynchronization
Example params
{ "group" : 62 }
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 name | Data type | Description |
---|---|---|
group | int | id of group |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group does not exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Member> | list of active (valid) members of the group |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getActiveGroupMembers
Example params
{ "group" : 47 }
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 name | Data type | Description |
---|---|---|
group | int | Group id |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Group> | admins |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAdminGroups
Example params
{ "group" : 89 }
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 name | Data type | Description |
---|---|---|
group | int | Group id |
onlyDirectAdmins | int | if == true, get only direct user administrators (if == false, get both direct and indirect) |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<User> | list of all group administrators of the given group for supported role |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAdmins
Example params
{ "group" : 98 , "onlyDirectAdmins" : 15 }
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 name | Data type | Description |
---|---|---|
group | int | Group id |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<User> | Group admins |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAdmins
Example params
{ "group" : 75 }
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 name | Data type | Description |
---|---|---|
sess | perun | session |
vo | int | parent VO id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | if given VO does not exist |
Return type | Description |
---|---|
list | of groups allowed to hierarchical VO. |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllAllowedGroupsToHierarchicalVo
Example params
{ "sess" : {...} , "vo" : 38 }
Example response
{ ... TODO ... }
Returns groups which can be included to VO from specific member VO.
Parameter name | Data type | Description |
---|---|---|
sess | perun | session |
vo | int | parent VO id |
memberVo | int | member VO id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | if given VO does not exist |
Return type | Description |
---|---|
list | of groups allowed to hierarchical VO. |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllAllowedGroupsToHierarchicalVo
Example params
{ "sess" : {...} , "vo" : 5 , "memberVo" : 79 }
Example response
{ ... TODO ... }
Get all groups from all vos. Returned groups are filtered based on the principal rights.
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Group> | 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 name | Data type | Description |
---|---|---|
vo | int | VO id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When the Vo doesn't exist |
Return type | Description |
---|---|
List<Group> | Groups |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllGroups
Example params
{ "vo" : 10 }
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 name | Data type | Description |
---|---|---|
vo | int | VO id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Object> | Groups with subgroups |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllGroupsWithHierarchy
Example params
{ "vo" : 7 }
Example response
{ ... TODO ... }
Returns all groups of specific member including group "members".
Parameter name | Data type | Description |
---|---|---|
member | int | id of member |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When the member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Group> | Groups of member |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllMemberGroups
Example params
{ "member" : 94 }
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 name | Data type | Description |
---|---|---|
attrNames | List<String> | list of attribute names to get |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
fromIndex | int | begin index of returned subList, included |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 32 , "fromIndex" : 9 , "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 filtered by user's role, 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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
fromIndex | int | begin index of returned subList, included |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
roles | list | of selected roles (if empty, then return groups by all roles) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 49 , "fromIndex" : 29 , "attrNames" : [ "text" , "text" ] , "roles" : {...} }
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 filtered by user's role assignment type, 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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
fromIndex | int | begin index of returned subList, included |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
types | list | of selected types of roles (if empty, then return by roles of all types) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 88 , "fromIndex" : 97 , "attrNames" : [ "text" , "text" ] , "types" : {...} }
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 filtered by user's role and its assignment type, 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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
fromIndex | int | begin index of returned subList, included |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
roles | list | of selected roles (if empty, then return groups by all roles) |
types | list | of selected types of roles (if empty, then return by roles of all types) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 66 , "fromIndex" : 72 , "attrNames" : [ "text" , "text" ] , "roles" : {...} , "types" : {...} }
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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
fromIndex | int | begin index of returned subList, included |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing all attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 36 , "fromIndex" : 24 }
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 filtered by user's role, 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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
roles | list | of selected roles (if empty, then return groups by all roles) |
fromIndex | int | begin index of returned subList, included |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing all attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 92 , "roles" : {...} , "fromIndex" : 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" : "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 filtered by user's role assignment type, 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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
types | list | of selected types of roles (if empty, then return by roles of all types) |
fromIndex | int | begin index of returned subList, included |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing all attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 25 , "types" : {...} , "fromIndex" : 93 }
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 filtered by user's role and its assignment type, 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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
roles | list | of selected roles (if empty, then return groups by all roles) |
types | list | of selected types of roles (if empty, then return by roles of all types) |
fromIndex | int | begin index of returned subList, included |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing all attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 64 , "roles" : {...} , "types" : {...} , "fromIndex" : 26 }
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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
toIndex | int | end index of returned subList, included |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 91 , "toIndex" : 28 , "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 filtered by user's role, 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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
toIndex | int | end index of returned subList, included |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
roles | list | of selected roles (if empty, then return groups by all roles) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 60 , "toIndex" : 4 , "attrNames" : [ "text" , "text" ] , "roles" : {...} }
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 filtered by user's role assignment type, 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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
toIndex | int | end index of returned subList, included |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
types | list | of selected types of roles (if empty, then return by roles of all types) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 72 , "toIndex" : 35 , "attrNames" : [ "text" , "text" ] , "types" : {...} }
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 filtered by user's role and its assignment type, 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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
toIndex | int | end index of returned subList, included |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
roles | list | of selected roles (if empty, then return groups by all roles) |
types | list | of selected types of roles (if empty, then return by roles of all types) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 29 , "toIndex" : 27 , "attrNames" : [ "text" , "text" ] , "roles" : {...} , "types" : {...} }
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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
toIndex | int | end index of returned subList, included |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing all attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 69 , "toIndex" : 48 }
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 filtered by user's role, 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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
roles | list | of selected roles (if empty, then return groups by all roles) |
toIndex | int | end index of returned subList, included |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing all attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 53 , "roles" : {...} , "toIndex" : 10 }
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 filtered by user's role assignment type, 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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
types | list | of selected types of roles (if empty, then return by roles of all types) |
toIndex | int | end index of returned subList, included |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing all attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 27 , "types" : {...} , "toIndex" : 18 }
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 filtered by user's role and its assignment type, 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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
roles | list | of selected roles (if empty, then return groups by all roles) |
types | list | of selected types of roles (if empty, then return by roles of all types) |
toIndex | int | end index of returned subList, included |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing all attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 18 , "roles" : {...} , "types" : {...} , "toIndex" : 79 }
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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
fromIndex | int | begin index of returned subList, included |
toIndex | int | end index of returned subList, included |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 43 , "fromIndex" : 9 , "toIndex" : 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 sub-list of all RichGroups filtered by user's role, 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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
fromIndex | int | begin index of returned subList, included |
toIndex | int | end index of returned subList, included |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
roles | list | of selected roles (if empty, then return groups by all roles) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 80 , "fromIndex" : 10 , "toIndex" : 96 , "attrNames" : [ "text" , "text" ] , "roles" : {...} }
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 filtered by user's role assignment type, 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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
fromIndex | int | begin index of returned subList, included |
toIndex | int | end index of returned subList, included |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
types | list | of selected types of roles (if empty, then return by roles of all types) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 97 , "fromIndex" : 73 , "toIndex" : 46 , "attrNames" : [ "text" , "text" ] , "types" : {...} }
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 filtered by user's role and its assignment type, 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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
fromIndex | int | begin index of returned subList, included |
toIndex | int | end index of returned subList, included |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
roles | list | of selected roles (if empty, then return groups by all roles) |
types | list | of selected types of roles (if empty, then return by roles of all types) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 76 , "fromIndex" : 95 , "toIndex" : 26 , "attrNames" : [ "text" , "text" ] , "roles" : {...} , "types" : {...} }
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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
fromIndex | int | begin index of returned subList, included |
toIndex | int | end index of returned subList, included |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing all attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 62 , "fromIndex" : 54 , "toIndex" : 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 sub-list of all RichGroups filtered by user's role, 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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
roles | list | of selected roles (if empty, then return groups by all roles) |
fromIndex | int | begin index of returned subList, included |
toIndex | int | end index of returned subList, included |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing all attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 91 , "roles" : {...} , "fromIndex" : 96 , "toIndex" : 49 }
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 filtered by user's role assignment type, 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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
types | list | of selected types of roles (if empty, then return by roles of all types) |
fromIndex | int | begin index of returned subList, included |
toIndex | int | end index of returned subList, included |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing all attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 35 , "types" : {...} , "fromIndex" : 31 , "toIndex" : 27 }
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 filtered by user's role and its assignment type, 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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
roles | list | of selected roles (if empty, then return groups by all roles) |
types | list | of selected types of roles (if empty, then return by roles of all types) |
fromIndex | int | begin index of returned subList, included |
toIndex | int | end index of returned subList, included |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing all attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 22 , "roles" : {...} , "types" : {...} , "fromIndex" : 23 , "toIndex" : 21 }
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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 15 , "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 filtered by user's role, containing selected attributes.
Parameter name | Data type | Description |
---|---|---|
vo | int | id of vo |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
roles | list | of selected roles (if empty, then return groups by all roles) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 52 , "attrNames" : [ "text" , "text" ] , "roles" : {...} }
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 filtered by user's role assignment type, containing selected attributes.
Parameter name | Data type | Description |
---|---|---|
vo | int | id of vo |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
types | list | of selected types of roles (if empty, then return by roles of all types) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 15 , "attrNames" : [ "text" , "text" ] , "types" : {...} }
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 filtered by user's role and its assignment type, containing selected attributes.
Parameter name | Data type | Description |
---|---|---|
vo | int | id of vo |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
roles | list | of selected roles (if empty, then return groups by all roles) |
types | list | of selected types of roles (if empty, then return by roles of all types) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 64 , "attrNames" : [ "text" , "text" ] , "roles" : {...} , "types" : {...} }
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 name | Data type | Description |
---|---|---|
vo | int | id of vo |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing all attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 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" } ] } , {...} , {...} ]
Returns full list of all RichGroups filtered by user's role, containing all attributes.
Parameter name | Data type | Description |
---|---|---|
vo | int | id of vo |
roles | list | of selected roles (if empty, then return groups by all roles) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing all attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 13 , "roles" : {...} }
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 filtered by user's role assignment type, containing all attributes.
Parameter name | Data type | Description |
---|---|---|
vo | int | id of vo |
types | list | of selected types of roles (if empty, then return by roles of all types) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing all attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 60 , "types" : {...} }
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 filtered by user's role and its assignment type, containing all attributes.
Parameter name | Data type | Description |
---|---|---|
vo | int | id of vo |
roles | list | of selected roles (if empty, then return groups by all roles) |
types | list | of selected types of roles (if empty, then return by roles of all types) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When Vo doesn't exist |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing all attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichGroupsWithAttributesByNames
Example params
{ "vo" : 28 , "roles" : {...} , "types" : {...} }
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 name | Data type | Description |
---|---|---|
group | int | id of group |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichSubGroupsWithAttributesByNames
Example params
{ "group" : 85 , "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 all AllRichSubGroups from parent group filtered by user's role, containing selected attributes (all level subgroups).
Parameter name | Data type | Description |
---|---|---|
group | int | id of group |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
roles | list | of selected roles (if empty, then return groups by all roles) |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichSubGroupsWithAttributesByNames
Example params
{ "group" : 66 , "attrNames" : [ "text" , "text" ] , "roles" : {...} }
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 filtered by user's role assignment type, containing selected attributes (all level subgroups).
Parameter name | Data type | Description |
---|---|---|
group | int | id of group |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
types | list | of selected types of roles (if empty, then return by roles of all types) |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichSubGroupsWithAttributesByNames
Example params
{ "group" : 22 , "attrNames" : [ "text" , "text" ] , "types" : {...} }
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 filtered by user's role and its assignment type, containing selected attributes (all level subgroups).
Parameter name | Data type | Description |
---|---|---|
group | int | id of group |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
roles | list | of selected roles (if empty, then return groups by all roles) |
types | list | of selected types of roles (if empty, then return by roles of all types) |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllRichSubGroupsWithAttributesByNames
Example params
{ "group" : 6 , "attrNames" : [ "text" , "text" ] , "roles" : {...} , "types" : {...} }
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 name | Data type | Description |
---|---|---|
parentGroup | int | Group id |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Group> | Child groups |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getAllSubGroups
Example params
{ "parentGroup" : 68 }
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 administrators of a group.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<User> | Group admins |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getDirectAdmins
Example params
{ "group" : 22 }
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 name | Data type | Description |
---|---|---|
group | int | Group id |
specificAttributes | List<String> | list of attributes URNs |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When the Vo doesn't exist |
Return type | Description |
---|---|
List<RichUser> | direct admins with attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getDirectRichAdminsWithSpecificAttributes
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 a group by id
.
Parameter name | Data type | Description |
---|---|---|
id | int | Group id |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Group | Found group |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getGroupById
Example params
{ "id" : 44 }
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 name | Data type | Description |
---|---|---|
vo | int | VO id |
name | String | Group name |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Group | Found group |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getGroupByName
Example params
{ "vo" : 23 , "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 name | Data type | Description |
---|---|---|
group | int | Group id |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Member> | Group members |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getGroupDirectMembers
Example params
{ "group" : 27 }
Example response
[ { "id" : 12 , "userId" : 34 , "voId" : 42 , "sourceGroupId" : null , "membershipType" : "DIRECT" , "status" : "VALID" , "sponsored" : false , "beanName" : "Member" } , {...} , {...} ]
Returns count of direct group members.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
int | Direct Members count |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getGroupDirectMembersCount
Example params
{ "group" : 64 }
Example response
86
Returns direct members of a group. RichMember contains User object.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichMember> | Group members |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getGroupDirectRichMembers
Example params
{ "group" : 89 }
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 name | Data type | Description |
---|---|---|
sess | perun | session |
group | int | Group id |
member | int | Member id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Member | member in context of group |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getGroupMemberById
Example params
{ "sess" : {...} , "group" : 78 , "member" : 86 }
Example response
{ "id" : 12 , "userId" : 34 , "voId" : 42 , "sourceGroupId" : null , "membershipType" : "DIRECT" , "status" : "VALID" , "sponsored" : false , "beanName" : "Member" }
Returns members of a group.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Member> | Group members |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getGroupMembers
Example params
{ "group" : 16 }
Example response
[ { "id" : 12 , "userId" : 34 , "voId" : 42 , "sourceGroupId" : null , "membershipType" : "DIRECT" , "status" : "VALID" , "sponsored" : false , "beanName" : "Member" } , {...} , {...} ]
Returns count of group members.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
int | Members count |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getGroupMembersCount
Example params
{ "group" : 99 }
Example response
1
Returns counts of group members by their group status.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
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" : 78 }
Example response
{ ... TODO ... }
Returns counts of group members by their status in VO.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
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" : 23 }
Example response
{ ... TODO ... }
Returns members of a group. RichMember contains User object.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichMember> | Group members |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getGroupRichMembers
Example params
{ "group" : 49 }
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 name | Data type | Description |
---|---|---|
group | int | Group id |
members | List<Integer> | id of members to be returned |
attrNames | List<String> | names of attributes |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichMember> | Group members |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getGroupRichMembersByIds
Example params
{ "group" : 83 , "members" : [ 66 , 87 ] , "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 name | Data type | Description |
---|---|---|
group | int | Group id |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichMember> | Group members |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getGroupRichMembersWithAttributes
Example params
{ "group" : 96 }
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 name | Data type | Description |
---|---|---|
group | int | id of Group to get groups in union. |
reverseDirection | boolean | FALSE (default) return INCLUDED groups / TRUE = return groups where INCLUDED |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Group> | List of groups in union relation. |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getGroupUnions
Example params
{ "group" : 40 , "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 name | Data type | Description |
---|---|---|
vo | int | VO id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When the Vo doesn't exist |
Return type | Description |
---|---|
List<Group> | Children groups |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getGroups
Example params
{ "vo" : 41 }
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 name | Data type | Description |
---|---|---|
ids | List<Integer> | list of groups IDs |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Group> | groups with specified IDs |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getGroupsByIds
Example params
{ "ids" : [ 54 , 95 ] }
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 name | Data type | Description |
---|---|---|
vo | int | VO id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When the Vo doesn't exist |
Return type | Description |
---|---|
int | Groups count |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getGroupsCount
Example params
{ "vo" : 35 }
Example response
49
Gets count of all groups.
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
int | groups count |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getGroupsCount
Example response
81
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 name | Data type | Description |
---|---|---|
vo | int | Vo id |
query | GroupsPageQuery | Query with page information |
attrNames | List<String> | List of attribute names |
Thrown exception | Description |
---|---|
GroupNotExistsException | if group was not found for given parameters |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberGroupMismatchException | if given Member is not in specified group |
MemberNotExistsException | if member was specified but not found |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | if there is no such vo |
Return type | Description |
---|---|
Paginated<RichGroup> | page of requested rich groups |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getGroupsPage
Example params
{ "vo" : 93 , "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 name | Data type | Description |
---|---|---|
member | int | id of member |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When the member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Group> | Groups where member is in active state (valid) |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getGroupsWhereMemberIsActive
Example params
{ "member" : 18 }
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 name | Data type | Description |
---|---|---|
member | int | id of member |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When the member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Group> | Groups where member is in inactive state (expired) |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getGroupsWhereMemberIsInactive
Example params
{ "member" : 77 }
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 user's groups where user is in active state (is valid there) and are subgroups of the specified VO Excluded members group.
Parameter name | Data type | Description |
---|---|---|
user | int | id of user |
vo | int | id of vo in which groups are looked up |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
UserNotExistsException | When the user does not exist |
VoNotExistsException | When the vo doesn't exist |
Return type | Description |
---|---|
List<Group> | Groups where user is in active state (valid), if the user is member of the given vo |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getGroupsWhereUserIsActiveMember
Example params
{ "user" : 3 , "vo" : 98 }
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 name | Data type | Description |
---|---|---|
group | int | id of group |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group does not exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Member> | list of inactive (expired) members of the group |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getInactiveGroupMembers
Example params
{ "group" : 92 }
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 name | Data type | Description |
---|---|---|
sess | perun | session |
member | member | |
group | group | in which the member is indirectly included |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
lists | of 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 name | Data type | Description |
---|---|---|
member | int | Member id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Group> | Groups of the member |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getMemberGroups
Example params
{ "member" : 68 }
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 name | Data type | Description |
---|---|---|
member | int | Member id |
attribute | Attribute | attribute object with value |
Thrown exception | Description |
---|---|
AttributeNotExistsException | When the attribute doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When the member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
WrongAttributeAssignmentException | Thrown while assigning atribute to wrong entity. |
Return type | Description |
---|---|
List<Group> | Groups of the member |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getMemberGroupsByAttribute
Example params
{ "member" : 52 , "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 name | Data type | Description |
---|---|---|
member | int | id of member |
fromIndex | int | begin index of returned subList, included |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When the member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getMemberRichGroupsWithAttributesByNames
Example params
{ "member" : 47 , "fromIndex" : 49 , "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 filtered by user's role, 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 name | Data type | Description |
---|---|---|
member | int | id of member |
fromIndex | int | begin index of returned subList, included |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
roles | list | of selected roles (if empty, then return groups by all roles) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When the member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getMemberRichGroupsWithAttributesByNames
Example params
{ "member" : 26 , "fromIndex" : 43 , "attrNames" : [ "text" , "text" ] , "roles" : {...} }
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 filtered by user's role assignment type, 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 name | Data type | Description |
---|---|---|
member | int | id of member |
fromIndex | int | begin index of returned subList, included |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
types | list | of selected types of roles (if empty, then return by roles of all types) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When the member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getMemberRichGroupsWithAttributesByNames
Example params
{ "member" : 45 , "fromIndex" : 78 , "attrNames" : [ "text" , "text" ] , "types" : {...} }
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 filtered by user's role and its assignment type, 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 name | Data type | Description |
---|---|---|
member | int | id of member |
fromIndex | int | begin index of returned subList, included |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
roles | list | of selected roles (if empty, then return groups by all roles) |
types | list | of selected types of roles (if empty, then return by roles of all types) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When the member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getMemberRichGroupsWithAttributesByNames
Example params
{ "member" : 64 , "fromIndex" : 52 , "attrNames" : [ "text" , "text" ] , "roles" : {...} , "types" : {...} }
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 name | Data type | Description |
---|---|---|
member | int | id of member |
toIndex | int | end index of returned subList, included |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When the member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getMemberRichGroupsWithAttributesByNames
Example params
{ "member" : 69 , "toIndex" : 72 , "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 filtered by user's role, 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 name | Data type | Description |
---|---|---|
member | int | id of member |
toIndex | int | end index of returned subList, included |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
roles | list | of selected roles (if empty, then return groups by all roles) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When the member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getMemberRichGroupsWithAttributesByNames
Example params
{ "member" : 0 , "toIndex" : 91 , "attrNames" : [ "text" , "text" ] , "roles" : {...} }
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 filtered by user's role assignment type, 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 name | Data type | Description |
---|---|---|
member | int | id of member |
toIndex | int | end index of returned subList, included |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
types | list | of selected types of roles (if empty, then return by roles of all types) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When the member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getMemberRichGroupsWithAttributesByNames
Example params
{ "member" : 14 , "toIndex" : 41 , "attrNames" : [ "text" , "text" ] , "types" : {...} }
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 filtered by user's role and its assignment type, 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 name | Data type | Description |
---|---|---|
member | int | id of member |
toIndex | int | end index of returned subList, included |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
roles | list | of selected roles (if empty, then return groups by all roles) |
types | list | of selected types of roles (if empty, then return by roles of all types) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When the member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getMemberRichGroupsWithAttributesByNames
Example params
{ "member" : 59 , "toIndex" : 46 , "attrNames" : [ "text" , "text" ] , "roles" : {...} , "types" : {...} }
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 name | Data type | Description |
---|---|---|
member | int | id of member |
fromIndex | int | begin index of returned subList, included |
toIndex | int | end index of returned subList, included |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When the member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getMemberRichGroupsWithAttributesByNames
Example params
{ "member" : 6 , "fromIndex" : 18 , "toIndex" : 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" } ] } , {...} , {...} ]
Returns sub-list of member's RichGroups filtered by user's role, 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 name | Data type | Description |
---|---|---|
member | int | id of member |
fromIndex | int | begin index of returned subList, included |
toIndex | int | end index of returned subList, included |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
roles | list | of selected roles (if empty, then return groups by all roles) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When the member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getMemberRichGroupsWithAttributesByNames
Example params
{ "member" : 94 , "fromIndex" : 15 , "toIndex" : 71 , "attrNames" : [ "text" , "text" ] , "roles" : {...} }
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 filtered by user's role assignment type, 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 name | Data type | Description |
---|---|---|
member | int | id of member |
fromIndex | int | begin index of returned subList, included |
toIndex | int | end index of returned subList, included |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
types | list | of selected types of roles (if empty, then return by roles of all types) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When the member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getMemberRichGroupsWithAttributesByNames
Example params
{ "member" : 33 , "fromIndex" : 28 , "toIndex" : 1 , "attrNames" : [ "text" , "text" ] , "types" : {...} }
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 filtered by user's role and its assignment type, 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 name | Data type | Description |
---|---|---|
member | int | id of member |
fromIndex | int | begin index of returned subList, included |
toIndex | int | end index of returned subList, included |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
roles | list | of selected roles (if empty, then return groups by all roles) |
types | list | of selected types of roles (if empty, then return by roles of all types) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When the member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getMemberRichGroupsWithAttributesByNames
Example params
{ "member" : 58 , "fromIndex" : 60 , "toIndex" : 90 , "attrNames" : [ "text" , "text" ] , "roles" : {...} , "types" : {...} }
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 name | Data type | Description |
---|---|---|
member | int | id of member |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When the member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getMemberRichGroupsWithAttributesByNames
Example params
{ "member" : 32 , "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 filtered by user's role, containing selected attributes. "members" group is not included! Supported are attributes from these namespaces: - group - member-group
Parameter name | Data type | Description |
---|---|---|
member | int | id of member |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
roles | list | of selected roles (if empty, then return groups by all roles) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When the member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getMemberRichGroupsWithAttributesByNames
Example params
{ "member" : 34 , "attrNames" : [ "text" , "text" ] , "roles" : {...} }
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 filtered by user's role assignment type, containing selected attributes. "members" group is not included! Supported are attributes from these namespaces: - group - member-group
Parameter name | Data type | Description |
---|---|---|
member | int | id of member |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
types | list | of selected types of roles (if empty, then return by roles of all types) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When the member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getMemberRichGroupsWithAttributesByNames
Example params
{ "member" : 76 , "attrNames" : [ "text" , "text" ] , "types" : {...} }
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 filtered by user's role and its assignment type, containing selected attributes. "members" group is not included! Supported are attributes from these namespaces: - group - member-group
Parameter name | Data type | Description |
---|---|---|
member | int | id of member |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
roles | list | of selected roles (if empty, then return groups by all roles) |
types | list | of selected types of roles (if empty, then return by roles of all types) |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When the member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getMemberRichGroupsWithAttributesByNames
Example params
{ "member" : 79 , "attrNames" : [ "text" , "text" ] , "roles" : {...} , "types" : {...} }
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 name | Data type | Description |
---|---|---|
group | int | Child group id |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
ParentGroupNotExistsException | When the parent group doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Group | Parent group |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getParentGroup
Example params
{ "group" : 65 }
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 name | Data type | Description |
---|---|---|
group | int | Child group id |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Member> | Parent group members |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getParentGroupMembers
Example params
{ "group" : 54 }
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 name | Data type | Description |
---|---|---|
group | int | Child group id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichMember> | Parent group members |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getParentGroupRichMembers
Example params
{ "group" : 55 }
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 name | Data type | Description |
---|---|---|
group | int | Child group id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichMember> | Parent group members |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getParentGroupRichMembersWithAttributes
Example params
{ "group" : 67 }
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.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
specificAttributes | List<String> | list of specified attributes which are needed in object richUser |
allUserAttributes | int | if == true, get all possible user attributes and ignore list of specificAttributes (if false, get only specific attributes) |
onlyDirectAdmins | int | if == true, get only direct group administrators (if false, get both direct and indirect) |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist 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. |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichUser> | list of RichUser administrators for the group and supported role with attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getRichAdmins
Example params
{ "group" : 76 , "specificAttributes" : [ "text" , "text" ] , "allUserAttributes" : 96 , "onlyDirectAdmins" : 2 }
Example response
[ { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "RichUser" , "userExtSources" : [ { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , {...} , {...} ], "userAttributes" : [ { "value" : "my_login" , "type" : "java.lang.String" , "entity" : "user" , "namespace" : "urn:perun:user:attribute-def:def" , "friendlyName" : "login-namespace:perun" , "writable" : true , "baseFriendlyName" : "login-namespace" , "friendlyNameParameter" : "perun" , "unique" : false , "displayName" : "Login in namespace: perun" , "description" : "Logname in namespace 'perun'." , "id" : 1905 , "beanName" : "Attribute" } ] } , {...} , {...} ]
Get all Group admins as RichUsers
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichUser> | admins |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getRichAdmins
Example params
{ "group" : 91 }
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 name | Data type | Description |
---|---|---|
group | int | Group id |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
UserNotExistsException | When the user doesn't exist |
Return type | Description |
---|---|
List<RichUser> | admins with attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getRichAdminsWithAttributes
Example params
{ "group" : 39 }
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 name | Data type | Description |
---|---|---|
group | int | Group id |
specificAttributes | List<String> | list of attributes URNs |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | When the Vo doesn't exist |
Return type | Description |
---|---|
List<RichUser> | admins with attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getRichAdminsWithSpecificAttributes
Example params
{ "group" : 48 , "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 name | Data type | Description |
---|---|---|
groupId | int | id of group |
attrNames | List<String> | if attrNames is null method will return RichGroup containing all attributes |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getRichGroupByIdWithAttributesByNames
Example params
{ "groupId" : 84 , "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 name | Data type | Description |
---|---|---|
member | int | Member id |
resource | int | Resource id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When the member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
ResourceNotExistsException | When the resource doesn't exist |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
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" : 65 , "resource" : 83 }
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 name | Data type | Description |
---|---|---|
member | int | Member id |
resource | int | Resource id |
attrNames | List<String> | names of attributes |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When the member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
ResourceNotExistsException | When the resource doesn't exist |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | groups with attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getRichGroupsAssignedToResourceWithAttributesByNames
Example params
{ "member" : 13 , "resource" : 58 , "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 name | Data type | Description |
---|---|---|
resource | int | Resource id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When the member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
ResourceNotExistsException | When the resource doesn't exist |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | groups with all group and group-resource attributes (non-empty) |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getRichGroupsAssignedToResourceWithAttributesByNames
Example params
{ "resource" : 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" } ] } , {...} , {...} ]
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 name | Data type | Description |
---|---|---|
resource | int | Resource id |
attrNames | List<String> | names of attributes |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When the member doesn't exist |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
ResourceNotExistsException | When the resource doesn't exist |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | groups with attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getRichGroupsAssignedToResourceWithAttributesByNames
Example params
{ "resource" : 73 , "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 name | Data type | Description |
---|---|---|
group | int | id of group |
attrNames | List<String> | if attrNames is null method will return RichGroups containing all attributes |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<RichGroup> | RichGroups containing selected attributes |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getRichSubGroupsWithAttributesByNames
Example params
{ "group" : 36 , "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 name | Data type | Description |
---|---|---|
parentGroup | int | Group id |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Group> | Child groups |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getSubGroups
Example params
{ "parentGroup" : 97 }
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 name | Data type | Description |
---|---|---|
parentGroup | int | Parent group id |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
int | Subgroups count |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getSubGroupsCount
Example params
{ "parentGroup" : 65 }
Example response
62
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 name | Data type | Description |
---|---|---|
group | int | Group id |
query | GroupsPageQuery | Query with page information |
attrNames | List<String> | List of attribute names |
Thrown exception | Description |
---|---|
GroupNotExistsException | if there is no such query group |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Paginated<RichGroup> | page of requested rich groups |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getSubgroupsPage
Example params
{ "group" : 35 , "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 name | Data type | Description |
---|---|---|
group | int | Group id |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Vo | Parent VO |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/getVo
Example params
{ "group" : 24 }
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 name | Data type | Description |
---|---|---|
group | id | of group |
vo | id | of parent vo |
Thrown exception | Description |
---|---|
GroupNotExistsException | if group does not exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
VoNotExistsException | if vo does not exist |
Return type | Description |
---|---|
boolean | true 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 groups which supply the last FACILITYADMIN in some Facility.
Parameter name | Data type | Description |
---|---|---|
groups | int[] | Array of Group IDs |
Thrown exception | Description |
---|---|
GroupNotExistsException | When a group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | Insufficient rights |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Group> | groups which supply the last FACILITYADMIN in some Facility |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/isGroupLastAdminInSomeFacility
Example params
{ "groups" : [ 31 , 95 ] }
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 groups which supply the last VOADMIN in some VO.
Parameter name | Data type | Description |
---|---|---|
groups | int[] | Array of Group IDs |
Thrown exception | Description |
---|---|
GroupNotExistsException | When a group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | Insufficient rights |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<Group> | groups which supply the last VOADMIN in some VO |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/isGroupLastAdminInSomeVo
Example params
{ "groups" : [ 86 , 64 ] }
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 true if Member is member of the Group
Parameter name | Data type | Description |
---|---|---|
group | int | Group ID |
member | int | Member ID |
Thrown exception | Description |
---|---|
GroupNotExistsException | When Group with id doesn't exist. |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
boolean | True if Member is member of the Group |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/isGroupMember
Example params
{ "group" : 38 , "member" : 68 }
Example response
true
Moves "movingGroup" (including subGroups) under "destinationGroup" as subGroup within same Vo. Indirect group members are also processed during move operation.
Parameter name | Data type | Description |
---|---|---|
destinationGroup | int | id of Group to have "movingGroup" as subGroup |
movingGroup | int | id of Group to be moved under "destinationGroup" |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
WrongAttributeValueException | When the value of the attribute is illegal or wrong |
WrongReferenceAttributeValueException | When the attribute of the reference has illegal value |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/moveGroup
Example params
{ "destinationGroup" : 74 , "movingGroup" : 41 }
Example response
null
Moves "movingGroup" (including subGroups) from it`s location to top-level. Indirect group members are also processed during move operation.
Parameter name | Data type | Description |
---|---|---|
movingGroup | int | id of Group to be moved under "destinationGroup" |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
WrongAttributeValueException | When the value of the attribute is illegal or wrong |
WrongReferenceAttributeValueException | When the attribute of the reference has illegal value |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/moveGroup
Example params
{ "movingGroup" : 9 }
Example response
null
Removes an admin of a group.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
user | int | User id |
Thrown exception | Description |
---|---|
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
UserNotAdminException | When the user is not an admin |
UserNotExistsException | Whern the user doesn't exist |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/removeAdmin
Example params
{ "group" : 18 , "user" : 12 }
Example response
null
Removes a group admin of a group.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
authorizedGroup | int | Group id |
Thrown exception | Description |
---|---|
GroupNotAdminException | - NO DESCRIPTION |
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/removeAdmin
Example params
{ "group" : 69 , "authorizedGroup" : 30 }
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 name | Data type | Description |
---|---|---|
resultGroup | int | id of Group to have removed "operandGroup" from subgroups |
operandGroup | int | id of Group to be removed from "resultGroup" subgroups |
Thrown exception | Description |
---|---|
GroupNotExistsException | If any group not exists in perun |
GroupRelationCannotBeRemoved | When the group relation cannot be removed |
GroupRelationDoesNotExist | If the relation doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/removeGroupUnion
Example params
{ "resultGroup" : 87 , "operandGroup" : 36 }
Example response
null
Removes unions between groups, where "operandGroups" are technically removed from subgroups of "resultGroup". Members from all "operandGroups" are removed from "resultGroup" if they were INDIRECT members sourcing from these groups only.
Parameter name | Data type | Description |
---|---|---|
resultGroup | int | id of Group to have removed "operandGroup" from subgroups |
operandGroups | List<Integer> | list of Groups to be removed from "resultGroup" subgroups |
Thrown exception | Description |
---|---|
GroupNotExistsException | If any group not exists in perun |
GroupRelationCannotBeRemoved | When the group relation cannot be removed |
GroupRelationDoesNotExist | If the relation doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/removeGroupUnions
Example params
{ "resultGroup" : 60 , "operandGroups" : [ 17 , 27 ] }
Example response
null
Removes a member from a group.
Parameter name | Data type | Description |
---|---|---|
group | int | Group id |
member | int | Member id |
Thrown exception | Description |
---|---|
AttributeNotExistsException | When attribute doesn't exist |
ExternallyManagedException | When the group is externally managed |
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When member doesn't exist |
NotGroupMemberException | When member is not in the group |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
WrongAttributeAssignmentException | When assigning atribute to wrong entity |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/removeMember
Example params
{ "group" : 98 , "member" : 79 }
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 name | Data type | Description |
---|---|---|
groups | List<Integer> | Group - can be empty id |
member | int | Member id |
Thrown exception | Description |
---|---|
AttributeNotExistsException | When attribute doesn't exist |
ExternallyManagedException | When the group is externally managed |
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When member doesn't exist |
NotGroupMemberException | When member is not in the group |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
WrongAttributeAssignmentException | When assigning atribute to wrong entity |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/removeMember
Example params
{ "groups" : [ 53 , 94 ] , "member" : 49 }
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 name | Data type | Description |
---|---|---|
group | int | Group id |
members | List<Integer> | Members - can be empty id |
Thrown exception | Description |
---|---|
AttributeNotExistsException | When attribute doesn't exist |
ExternallyManagedException | When the group is externally managed |
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
MemberNotExistsException | When member doesn't exist |
NotGroupMemberException | When member is not in the group |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
WrongAttributeAssignmentException | When assigning atribute to wrong entity |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/removeMembers
Example params
{ "group" : 1 , "members" : [ 29 , 92 ] }
Example response
null
Resumes previously suspended group (and group structure) synchronization.
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/resumeGroupSynchronization
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 name | Data type | Description |
---|---|---|
member | int | Member id |
group | int | Group id |
status | String | VALID | EXPIRED |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Member | Member with status after change |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/setGroupsMemberStatus
Example params
{ "member" : 32 , "group" : 90 , "status" : "EXPIRED" }
Example response
{ "id" : 12 , "userId" : 34 , "voId" : 42 , "sourceGroupId" : null , "membershipType" : "DIRECT" , "status" : "VALID" , "sponsored" : false , "beanName" : "Member" }
Suspend synchronizing groups and their structures. Groups being currently synchronized will finish. This is only for temporary suspension, synchronizations will always resume on instance restart. In order to disable synchronizations permanently, use config properties.
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/groupsManager/suspendGroupSynchronization
Example response
null
Updates a group.
Parameter name | Data type | Description |
---|---|---|
group | Group | JSON Group class |
Thrown exception | Description |
---|---|
GroupExistsException | when the group with the same name already exists in the same vo |
GroupNotExistsException | When the group doesn't exist |
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
ObjectIDMismatchException | when IDs in passed group object doesn't match their actual value in Perun |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
Group | Updated 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" }