openapi: 3.2.0 info: title: Cesnet Groups Manager API version: 0.0.0 contact: url: https://perun-aai.org email: perun@cesnet.cz description: 'Operations tagged GroupsManager across 2 of this provider''s published API definitions: cesnet-perun-rpc-openapi.yml, cesnet-perun-rpc-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed security: - BasicAuth: [] - BearerAuth: [] tags: - name: GroupsManager description: GroupsManager RPC API in Perun externalDocs: url: https://perun-aai.org/documentation/technical-documentation/rpc-api/rpc-javadoc-GroupsManager.html paths: /json/groupsManager/getGroupById: get: tags: - GroupsManager operationId: getGroupById summary: Returns a group by id description: Throws GroupNotExistsException when the group doesn't exist. parameters: - $ref: '#/components/parameters/id' responses: '200': $ref: '#/components/responses/GroupResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getGroupByUUID: get: tags: - GroupsManager operationId: getGroupByUUID summary: Returns a group by uuid description: Throws GroupNotExistsException when the group doesn't exist. parameters: - $ref: '#/components/parameters/groupUuid' responses: '200': $ref: '#/components/responses/GroupResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getRichGroupByIdWithAttributesByNames: get: tags: - GroupsManager operationId: getRichGroupByIdWithAttributesByNames summary: Returns RichGroup selected by id containing selected attributes description: Throws GroupNotExistsException when the group doesn't exist. parameters: - name: groupId description: id of Group schema: type: integer in: query required: true - $ref: '#/components/parameters/attrNamesOptional' responses: '200': $ref: '#/components/responses/RichGroupResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getGroupByName: get: tags: - GroupsManager operationId: getGroupByName description: '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'') Throws GroupNotExistsException when the group doesn''t exist.' parameters: - $ref: '#/components/parameters/voId' - $ref: '#/components/parameters/name' responses: '200': $ref: '#/components/responses/GroupResponse' default: $ref: '#/components/responses/ExceptionResponse' summary: Get group by name x-summary-source: derived servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getGroupsByIds: get: tags: - GroupsManager operationId: getGroupsByIds summary: Returns list of groups by their ids parameters: - $ref: '#/components/parameters/ids' responses: '200': $ref: '#/components/responses/ListOfGroupsResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getSubGroups: get: tags: - GroupsManager operationId: getSubGroups summary: Returns direct subgroups of a group (single level) parameters: - name: parentGroup description: Parent Group id schema: type: integer in: query required: true responses: '200': $ref: '#/components/responses/ListOfGroupsResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getGroupMembers: get: tags: - GroupsManager operationId: getGroupMembers summary: Returns list of members of a group parameters: - $ref: '#/components/parameters/groupId' responses: '200': $ref: '#/components/responses/ListOfMembersResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/isGroupLastAdminInSomeFacility: get: tags: - GroupsManager operationId: isGroupLastAdminInSomeFacility summary: Return groups which supply the last FACILITYADMIN in some Facility parameters: - $ref: '#/components/parameters/groupIds' responses: '200': $ref: '#/components/responses/ListOfGroupsResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/isGroupLastAdminInSomeVo: get: tags: - GroupsManager operationId: isGroupLastAdminInSomeVo summary: Returns groups which supply the last VOADMIN in some VO parameters: - $ref: '#/components/parameters/groupIds' responses: '200': $ref: '#/components/responses/ListOfGroupsResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/isGroupMember: get: tags: - GroupsManager operationId: isGroupMember summary: Return true if Member is member of the Group parameters: - $ref: '#/components/parameters/memberId' - $ref: '#/components/parameters/groupId' responses: '200': $ref: '#/components/responses/BooleanResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getMemberGroups: get: tags: - GroupsManager operationId: getMemberGroups summary: Returns groups for a member parameters: - $ref: '#/components/parameters/memberId' responses: '200': $ref: '#/components/responses/ListOfGroupsResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getAllMemberGroups: get: tags: - GroupsManager operationId: getAllMemberGroups summary: Returns all groups for a member including group 'members' parameters: - $ref: '#/components/parameters/memberId' responses: '200': $ref: '#/components/responses/ListOfGroupsResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getAllGroups/all: get: tags: - GroupsManager operationId: getAllGroupsFromAllVos summary: Get all groups from all vos. responses: '200': $ref: '#/components/responses/ListOfGroupsResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getAllGroups: get: tags: - GroupsManager operationId: getAllGroups summary: Returns all groups in a VO parameters: - $ref: '#/components/parameters/voId' responses: '200': $ref: '#/components/responses/ListOfGroupsResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getGroups: get: tags: - GroupsManager operationId: getAllMyGroups summary: Returns all groups in a VO the user has access to parameters: - $ref: '#/components/parameters/voId' responses: '200': $ref: '#/components/responses/ListOfGroupsResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getAllRichGroups: get: tags: - GroupsManager operationId: getAllRichGroups summary: Get all groups with their specified attributes. parameters: - $ref: '#/components/parameters/attrNames' responses: '200': $ref: '#/components/responses/ListOfRichGroupsResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getAllRichGroupsWithAttributesByNames: get: tags: - GroupsManager operationId: getAllRichGroupsWithAttributesByNames summary: Returns full list of all RichGroups containing selected attributes parameters: - $ref: '#/components/parameters/voId' - $ref: '#/components/parameters/attrNames' - name: roles[] schema: type: array items: $ref: '#/components/schemas/GroupAdminRoles' in: query description: 'list of roles: GROUPADMIN, GROUPOBSERVER, GROUPMEMBERSHIPMANAGER' - name: types[] schema: type: array items: $ref: '#/components/schemas/RoleAssignmentType' in: query description: 'list of role types: DIRECT, INDIRECT' responses: '200': $ref: '#/components/responses/ListOfRichGroupsResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getAllRichSubGroupsWithAttributesByNames: get: tags: - GroupsManager operationId: getAllRichSubGroupsWithGroupAttributesByNames summary: Returns all AllRichSubGroups from parent group containing selected attributes… parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/attrNamesOptional' - name: roles[] schema: type: array items: $ref: '#/components/schemas/GroupAdminRoles' in: query description: 'list of roles: GROUPADMIN, GROUPOBSERVER, GROUPMEMBERSHIPMANAGER' - name: types[] schema: type: array items: $ref: '#/components/schemas/RoleAssignmentType' in: query description: 'list of role types: DIRECT, INDIRECT' responses: '200': $ref: '#/components/responses/ListOfRichGroupsResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /urlinjsonout/groupsManager/createGroup/v-n-d: post: tags: - GroupsManager operationId: createGroupWithVoNameDescription description: Creates a new group in the specific VO. parameters: - $ref: '#/components/parameters/voId' - $ref: '#/components/parameters/groupName' - $ref: '#/components/parameters/groupDescription' responses: '200': $ref: '#/components/responses/GroupResponse' default: $ref: '#/components/responses/ExceptionResponse' summary: Create group with vo name description x-summary-source: derived servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /urlinjsonout/groupsManager/createGroup/pg-n-d: post: tags: - GroupsManager operationId: createGroupWithParentGroupNameDescription description: Creates a subgroup of a group. parameters: - name: parentGroup description: Parent Group id schema: type: integer in: query required: true - $ref: '#/components/parameters/groupName' - $ref: '#/components/parameters/groupDescription' responses: '200': $ref: '#/components/responses/GroupResponse' default: $ref: '#/components/responses/ExceptionResponse' summary: Create group with parent group name description x-summary-source: derived servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /urlinjsonout/groupsManager/deleteGroup: post: tags: - GroupsManager operationId: deleteGroup summary: Deletes group with given id if it contains no members and group is not assigned… parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/forceDelete' responses: '200': $ref: '#/components/responses/VoidResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/deleteGroups: post: tags: - GroupsManager operationId: deleteGroups summary: Forcefully deletes a list of groups (remove all group members, remove group… responses: '200': $ref: '#/components/responses/VoidResponse' default: $ref: '#/components/responses/ExceptionResponse' requestBody: required: true content: application/json: schema: title: InputDeleteGroups description: input to deleteGroup type: object required: - groups - forceDelete properties: groups: type: array items: type: integer forceDelete: type: boolean description: boolean for force delete servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /urlinjsonout/groupsManager/getGroupsWhereAutoRegistrationWillBeBrokenByMovingGroup/dg-mg: post: tags: - GroupsManager operationId: getGroupsWhereAutoRegistrationWillBeBrokenByMovingGroup summary: The groups embedded for an auto-registration in a group form need to be… parameters: - name: destinationGroup description: id of Group to have 'movingGroup' as subGroup schema: type: integer in: query required: false - name: movingGroup description: id of Group to be moved under 'destinationGroup' schema: type: integer in: query required: true responses: '200': $ref: '#/components/responses/ListOfGroupsResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /urlinjsonout/groupsManager/moveGroup/dg-mg: post: tags: - GroupsManager operationId: moveGroupWithDestinationGroupMovingGroup summary: Moves "movingGroup" (including subGroups) under "destinationGroup" as subGroup… parameters: - name: destinationGroup description: id of Group to have 'movingGroup' as subGroup schema: type: integer in: query required: false - name: movingGroup description: id of Group to be moved under 'destinationGroup' schema: type: integer in: query required: true responses: '200': $ref: '#/components/responses/VoidResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /urlinjsonout/groupsManager/addMember: post: tags: - GroupsManager operationId: addMember summary: Add member to groups. If already a member of a group, the group will be skipped parameters: - $ref: '#/components/parameters/groupIds' - $ref: '#/components/parameters/memberId' responses: '200': $ref: '#/components/responses/VoidResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /urlinjsonout/groupsManager/addMembers: post: tags: - GroupsManager operationId: addMembers summary: Adds members to a group. parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/memberIds' responses: '200': $ref: '#/components/responses/VoidResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /urlinjsonout/groupsManager/copyMembers: post: tags: - GroupsManager operationId: copyMembers summary: Copies direct members from one group to other groups within the same VO. parameters: - name: sourceGroup description: id of the group to copy from schema: type: integer in: query required: true - name: destinationGroups description: ids of groups to copy to schema: type: array items: type: integer in: query required: true - name: members description: ids of members to copy schema: type: array items: type: integer in: query required: false responses: '200': $ref: '#/components/responses/VoidResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /urlinjsonout/groupsManager/removeMember: post: tags: - GroupsManager operationId: removeMember summary: Removes member from a groups. parameters: - $ref: '#/components/parameters/groupIds' - $ref: '#/components/parameters/memberId' responses: '200': $ref: '#/components/responses/VoidResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /urlinjsonout/groupsManager/removeMembers: post: tags: - GroupsManager operationId: removeMembers summary: Removes members from a group. parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/memberIds' responses: '200': $ref: '#/components/responses/VoidResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/removeMembers: post: tags: - GroupsManager operationId: removeMembersBodyParams summary: Removes members from a group. responses: '200': $ref: '#/components/responses/VoidResponse' default: $ref: '#/components/responses/ExceptionResponse' requestBody: required: true content: application/json: schema: title: InputRemoveMembers description: input to remove members type: object required: - group - members properties: group: type: integer members: type: array items: type: integer servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /urlinjsonout/groupsManager/createGroupUnion: post: tags: - GroupsManager operationId: createGroupUnion summary: Create union of two groups, where "operandGroup" is technically set as subgroup… parameters: - $ref: '#/components/parameters/resultGroupId' - $ref: '#/components/parameters/operandGroupId' responses: '200': $ref: '#/components/responses/VoidResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getGroupUnions: get: tags: - GroupsManager operationId: getGroupUnions summary: Return all operand groups for specified result groups (all INCLUDED groups). parameters: - $ref: '#/components/parameters/groupId' - name: reverseDirection description: FALSE (default) return INCLUDED groups / TRUE = return groups where INCLUDED schema: type: boolean in: query required: true responses: '200': $ref: '#/components/responses/ListOfGroupsResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /urlinjsonout/groupsManager/setGroupsMemberStatus: post: tags: - GroupsManager operationId: setGroupsMemberStatus summary: Set membership status of a member in a group. parameters: - $ref: '#/components/parameters/memberId' - $ref: '#/components/parameters/groupId' - name: status description: status (VALID | EXPIRED) schema: type: string in: query required: true responses: '200': $ref: '#/components/responses/MemberResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /urlinjsonout/groupsManager/extendMembershipInGroup: post: tags: - GroupsManager operationId: extendMembershipInGroup summary: Extend member membership in given group using membershipExpirationRules… parameters: - $ref: '#/components/parameters/memberId' - $ref: '#/components/parameters/groupId' responses: '200': $ref: '#/components/responses/VoidResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/canExtendMembershipInGroup: get: tags: - GroupsManager operationId: canExtendMembershipInGroup summary: Returns true if member in given group can extend membership or if no rules were… parameters: - $ref: '#/components/parameters/memberId' - $ref: '#/components/parameters/groupId' responses: '200': $ref: '#/components/responses/BooleanResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/canExtendInNewRegistrarGroup: get: tags: - GroupsManager operationId: canExtendInNewRegistrarGroup summary: Returns true if member in given group can extend membership or if no rules were… parameters: - $ref: '#/components/parameters/memberId' - $ref: '#/components/parameters/groupId' responses: '200': $ref: '#/components/responses/BooleanResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /urlinjsonout/groupsManager/removeGroupUnion: post: tags: - GroupsManager operationId: removeGroupUnion summary: Removes union of two groups, when "operandGroup" is technically removed from… parameters: - $ref: '#/components/parameters/resultGroupId' - $ref: '#/components/parameters/operandGroupId' responses: '200': $ref: '#/components/responses/VoidResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /urlinjsonout/groupsManager/removeGroupUnions: post: tags: - GroupsManager operationId: removeGroupUnions summary: Removes unions of groups, where "operandGroups" are technically removed from… parameters: - $ref: '#/components/parameters/resultGroupId' - $ref: '#/components/parameters/operandGroupIds' responses: '200': $ref: '#/components/responses/VoidResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /urlinjsonout/groupsManager/forceGroupSynchronization: post: tags: - GroupsManager operationId: forceGroupSynchronization summary: Forces group synchronization parameters: - $ref: '#/components/parameters/groupId' responses: '200': $ref: '#/components/responses/VoidResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /urlinjsonout/groupsManager/forceGroupStructureSynchronization: post: tags: - GroupsManager operationId: forceGroupStructureSynchronization summary: Forces group structure synchronization parameters: - $ref: '#/components/parameters/groupId' responses: '200': $ref: '#/components/responses/VoidResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /urlinjsonout/groupsManager/forceAllSubGroupsSynchronization: post: tags: - GroupsManager operationId: forceAllSubGroupsSynchronization summary: Force synchronization for all subgroups (recursively - whole tree) of the group… parameters: - $ref: '#/components/parameters/groupId' responses: '200': $ref: '#/components/responses/VoidResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/updateGroup: post: tags: - GroupsManager operationId: updateGroup summary: Updates a group responses: '200': $ref: '#/components/responses/GroupResponse' default: $ref: '#/components/responses/ExceptionResponse' requestBody: required: true content: application/json: schema: title: InputUpdateGroup description: input to updateGroup type: object required: - group properties: group: $ref: '#/components/schemas/Group' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getGroupMembersCount: get: tags: - GroupsManager operationId: getGroupMembersCount summary: Returns count of group members parameters: - $ref: '#/components/parameters/groupId' responses: '200': $ref: '#/components/responses/IntegerResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getGroupDirectMembersCount: get: tags: - GroupsManager operationId: getGroupDirectMembersCount summary: Returns count of direct group members parameters: - $ref: '#/components/parameters/groupId' responses: '200': $ref: '#/components/responses/IntegerResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getGroupMembersCountsByVoStatus: get: tags: - GroupsManager operationId: getGroupMembersCountsByVoStatus summary: Returns counts of group members by their status in VO parameters: - $ref: '#/components/parameters/groupId' responses: '200': $ref: '#/components/responses/MapStringIntegerResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getGroupMembersCountsByGroupStatus: get: tags: - GroupsManager operationId: getGroupMembersCountsByGroupStatus summary: Returns counts of group members by their group status parameters: - $ref: '#/components/parameters/groupId' responses: '200': $ref: '#/components/responses/MapStringIntegerResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getMemberRichGroupsWithAttributesByNames: get: tags: - GroupsManager operationId: getMemberRichGroupsWithAttributesByNames summary: Returns full list of member's RichGroups containing selected attributes. parameters: - $ref: '#/components/parameters/memberId' - $ref: '#/components/parameters/attrNames' - name: roles[] schema: type: array items: $ref: '#/components/schemas/GroupAdminRoles' in: query description: 'list of roles: GROUPADMIN, GROUPOBSERVER, GROUPMEMBERSHIPMANAGER' - name: types[] schema: type: array items: $ref: '#/components/schemas/RoleAssignmentType' in: query description: 'list of role types: DIRECT, INDIRECT' responses: '200': $ref: '#/components/responses/ListOfRichGroupsResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getParentGroup: get: tags: - GroupsManager operationId: getParentGroup summary: Returns a parent group of a group parameters: - $ref: '#/components/parameters/groupId' responses: '200': $ref: '#/components/responses/GroupResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getAllSubGroups: get: tags: - GroupsManager operationId: getAllSubGroups summary: Returns all subgroups of a group parameters: - $ref: '#/components/parameters/groupId' responses: '200': $ref: '#/components/responses/ListOfGroupsResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getIndirectMembershipPaths: get: tags: - GroupsManager operationId: getIndirectMembershipPaths summary: Returns unique paths of groups as list of lists of groups [CURRENT GROUP ->… parameters: - $ref: '#/components/parameters/memberId' - $ref: '#/components/parameters/groupId' responses: '200': $ref: '#/components/responses/ListOfListsOfGroupsResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getGroupMemberById: get: tags: - GroupsManager operationId: getGroupMemberById summary: Get member in context of group parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/memberId' responses: '200': $ref: '#/components/responses/MemberResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getGroupRichMembersByIds: get: tags: - GroupsManager operationId: getGroupRichMembersByIds summary: Returns list of RichMembers with requested attributes by their member IDs from… parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/memberIds' - $ref: '#/components/parameters/attrNames' responses: '200': $ref: '#/components/responses/ListOfRichMembersResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getGroupsPage: post: tags: - GroupsManager operationId: getGroupsPage summary: Get page of groups from the given vo responses: '200': $ref: '#/components/responses/PaginatedRichGroupsResponse' default: $ref: '#/components/responses/ExceptionResponse' requestBody: required: true content: application/json: schema: title: InputGetPaginatedGroups description: input to getPaginatedGroups type: object required: - vo - query - attrNames properties: vo: type: integer attrNames: type: array items: type: string query: $ref: '#/components/schemas/GroupsPageQuery' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getSubgroupsPage: post: tags: - GroupsManager operationId: getSubgroupsPage summary: Get page of subgroups from the given parent group responses: '200': $ref: '#/components/responses/PaginatedRichGroupsResponse' default: $ref: '#/components/responses/ExceptionResponse' requestBody: required: true content: application/json: schema: title: InputGetPaginatedSubgroups description: input to getSubgroupsPage type: object required: - group - query - attrNames properties: group: type: integer attrNames: type: array items: type: string query: $ref: '#/components/schemas/GroupsPageQuery' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /urlinjsonout/groupsManager/allowGroupToHierarchicalVo: post: tags: - GroupsManager operationId: allowGroupToHierarchicalVo summary: Sets flag required for including group to parent vo in a vo hierarchy parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/voId' responses: '200': $ref: '#/components/responses/VoidResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /urlinjsonout/groupsManager/allowGroupsToHierarchicalVo: post: tags: - GroupsManager operationId: allowGroupsToHierarchicalVo summary: Sets flag required for including groups to parent vo in a vo hierarchy parameters: - $ref: '#/components/parameters/groupIds' - $ref: '#/components/parameters/voId' responses: '200': $ref: '#/components/responses/VoidResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /urlinjsonout/groupsManager/disallowGroupToHierarchicalVo: post: tags: - GroupsManager operationId: disallowGroupToHierarchicalVo summary: Unsets flag required for including group to parent vo in a vo hierarchy parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/voId' responses: '200': $ref: '#/components/responses/VoidResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /urlinjsonout/groupsManager/disallowGroupsToHierarchicalVo: post: tags: - GroupsManager operationId: disallowGroupsToHierarchicalVo summary: Unsets flag required for including groups to parent vo in a vo hierarchy parameters: - $ref: '#/components/parameters/groupIds' - $ref: '#/components/parameters/voId' responses: '200': $ref: '#/components/responses/VoidResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/isAllowedGroupToHierarchicalVo: get: tags: - GroupsManager operationId: isAllowedGroupToHierarchicalVo summary: Returns flag representing if the group can be included in the (parent) vo's… parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/voId' responses: '200': $ref: '#/components/responses/BooleanResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getAllAllowedGroupsToHierarchicalVo/v: get: tags: - GroupsManager operationId: getAllAllowedGroupsToHierarchicalVo summary: Returns all groups which can be included to VO parameters: - $ref: '#/components/parameters/voId' responses: '200': $ref: '#/components/responses/ListOfGroupsResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getAllAllowedGroupsToHierarchicalVo/v-v: get: tags: - GroupsManager operationId: getVoAllAllowedGroupsToHierarchicalVo summary: Returns all groups which can be included to VO from specific member VO parameters: - $ref: '#/components/parameters/voId' - $ref: '#/components/parameters/memberVoId' responses: '200': $ref: '#/components/responses/ListOfGroupsResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getGroupsWhereMemberIsActive: get: tags: - GroupsManager operationId: getGroupsWhereMemberIsActive summary: Returns list of groups where member is in active state parameters: - $ref: '#/components/parameters/memberId' responses: '200': $ref: '#/components/responses/ListOfGroupsResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/getGroupsWhereUserIsActiveMember: get: tags: - GroupsManager operationId: getGroupsWhereUserIsActiveMember summary: Returns list of groups where user is member in active state. parameters: - $ref: '#/components/parameters/userId' - $ref: '#/components/parameters/voId' responses: '200': $ref: '#/components/responses/ListOfGroupsResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /urlinjsonout/groupsManager/suspendGroupSynchronization: post: tags: - GroupsManager operationId: suspendGroupSynchronization summary: Suspends group synchronization. Groups being currently synchronized will finish responses: '200': $ref: '#/components/responses/VoidResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /urlinjsonout/groupsManager/resumeGroupSynchronization: post: tags: - GroupsManager operationId: resumeGroupSynchronization summary: Resumes previously suspended group synchronization responses: '200': $ref: '#/components/responses/VoidResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed /json/groupsManager/isSuspendedGroupSynchronization: get: tags: - GroupsManager operationId: isSuspendedGroupSynchronization summary: Return true if group synchronization has been suspended responses: '200': $ref: '#/components/responses/BooleanResponse' default: $ref: '#/components/responses/ExceptionResponse' servers: - url: https://{server}/{authentication}/rpc description: Perun RPC server variables: server: default: api-dev.perun-aai.org description: DNS name of a Perun server authentication: default: ba description: 'way of authentication: ba - HTTP Basic Auth krb - Kerberos non - no authentication cert - X509 client certificate oauth - OAuth 2.0 bearer access token fed - SAML federation ' enum: - ba - krb - non - cert - oauth - fed components: parameters: attrNamesOptional: name: attrNames[] description: list of attribute names List or null in: query required: false schema: type: array items: type: string userId: name: user description: id of User schema: type: integer in: query required: true voId: name: vo description: id of Vo schema: type: integer in: query required: true forceDelete: name: force description: If true, delete entity forcefully. schema: type: boolean in: query required: false ids: name: ids[] description: list of ids List in: query required: true schema: type: array items: type: integer operandGroupId: name: operandGroup description: id of Group to have removed 'resultGroup' from subgroups schema: type: integer in: query required: true attrNames: name: attrNames description: list of attribute names List in: query required: true schema: type: array items: type: string memberId: name: member description: id of Member schema: type: integer in: query required: true groupUuid: name: uuid description: uuid of Group schema: type: string format: uuid in: query required: true groupId: name: group description: id of Group schema: type: integer in: query required: true memberIds: name: members[] description: id of Member schema: type: array items: type: integer in: query required: true groupDescription: name: description description: description of Group schema: type: string in: query required: true groupName: name: name description: name of Group schema: type: string in: query required: true memberVoId: name: memberVo description: id of member Vo schema: type: integer in: query required: true resultGroupId: name: resultGroup description: id of Group to have removed 'operandGroup' from subgroups schema: type: integer in: query required: true operandGroupIds: name: operandGroups[] description: IDs of Groups to be removed from 'resultGroup' subgroups schema: type: array items: type: integer in: query required: true id: name: id description: numeric id schema: type: integer in: query required: true groupIds: name: groups[] description: list of Group ids List in: query required: true schema: type: array items: type: integer name: name: name description: name of entity schema: type: string in: query required: true schemas: AttributeDefinition: allOf: - $ref: '#/components/schemas/Auditable' properties: friendlyName: type: string namespace: type: string description: type: - string - 'null' type: type: string displayName: type: string writable: type: boolean unique: type: boolean friendlyNameParameter: type: string readOnly: true baseFriendlyName: type: string readOnly: true entity: type: string readOnly: true PerunBean: description: identifiable entity in Perun, common ancestor of all entity classes type: object properties: id: type: integer beanName: type: string required: - id - beanName discriminator: propertyName: beanName GroupsOrderColumn: type: string enum: - ID - NAME - DESCRIPTION GroupAdminRoles: type: string description: admin roles for a group enum: - GROUPOBSERVER - GROUPMEMBERSHIPMANAGER - GROUPADMIN - GROUPCREATOR GroupsPageQuery: properties: pageSize: type: integer offset: type: integer order: $ref: '#/components/schemas/SortingOrder' sortColumn: $ref: '#/components/schemas/GroupsOrderColumn' memberId: type: integer searchString: type: string roles: type: array items: $ref: '#/components/schemas/GroupAdminRoles' types: type: array items: $ref: '#/components/schemas/RoleAssignmentType' required: - pageSize - offset - order - sortColumn RichMember: description: Member data packed with member and user attributes, User and UserExtSources allOf: - $ref: '#/components/schemas/Member' properties: user: $ref: '#/components/schemas/User' userExtSources: type: - array - 'null' items: $ref: '#/components/schemas/UserExtSource' userAttributes: type: - array - 'null' items: $ref: '#/components/schemas/Attribute' memberAttributes: type: - array - 'null' items: $ref: '#/components/schemas/Attribute' required: - user - userExtSources UserExtSource: description: represents specific user authentication or identification in external source of data allOf: - $ref: '#/components/schemas/Auditable' properties: login: type: string userId: type: integer loa: type: integer persistent: type: boolean lastAccess: type: string format: timestamp description: SQL timestamp example: '2012-01-01 00:00:00.100000' extSource: $ref: '#/components/schemas/ExtSource' required: - login - extSource RichGroup: allOf: - $ref: '#/components/schemas/Group' properties: attributes: type: array items: $ref: '#/components/schemas/Attribute' Group: allOf: - $ref: '#/components/schemas/Auditable' type: - object - 'null' properties: name: type: string shortName: type: string description: type: - string - 'null' voId: type: integer parentGroupId: type: - integer - 'null' uuid: type: string format: uuid PerunException: description: exception thrown from inside of Perun type: object properties: errorId: type: string name: type: string message: type: string ExtSource: description: represents external source of data for users such as an IdP or an HR database allOf: - $ref: '#/components/schemas/Auditable' properties: name: type: string type: type: string Auditable: description: represents audit information allOf: - $ref: '#/components/schemas/PerunBean' properties: createdAt: type: - string - 'null' createdBy: type: - string - 'null' modifiedAt: type: - string - 'null' modifiedBy: type: - string - 'null' createdByUid: type: - integer - 'null' modifiedByUid: type: - integer - 'null' SortingOrder: type: string enum: - ASCENDING - DESCENDING PaginatedRichGroups: properties: offset: type: integer pageSize: type: integer totalCount: type: integer data: type: array items: $ref: '#/components/schemas/RichGroup' required: - offset - pageSize - totalCount - data User: description: represents user as a physical person allOf: - $ref: '#/components/schemas/Auditable' properties: firstName: type: - string - 'null' lastName: type: - string - 'null' middleName: type: - string - 'null' titleBefore: type: - string - 'null' titleAfter: type: - string - 'null' serviceUser: type: boolean sponsoredUser: type: boolean uuid: type: string format: uuid specificUser: type: boolean majorSpecificType: type: string RoleAssignmentType: type: string description: type of role assignment enum: - DIRECT - INDIRECT Attribute: allOf: - $ref: '#/components/schemas/AttributeDefinition' properties: valueCreatedAt: type: - string - 'null' valueCreatedBy: type: - string - 'null' valueModifiedAt: type: - string - 'null' valueModifiedBy: type: - string - 'null' value: {} Member: description: represents Member of a Virtual Organization allOf: - $ref: '#/components/schemas/Auditable' properties: userId: type: integer voId: type: integer status: type: string membershipType: type: string dualMembership: type: boolean sourceGroupId: type: - integer - 'null' sponsored: type: boolean groupStatus: type: string groupStatuses: type: object additionalProperties: type: string responses: PaginatedRichGroupsResponse: description: returns Paginated content: application/json: schema: $ref: '#/components/schemas/PaginatedRichGroups' ListOfListsOfGroupsResponse: description: returns List> content: application/json: schema: type: array items: type: array items: $ref: '#/components/schemas/Group' VoidResponse: description: returns nothing GroupResponse: description: returns Group content: application/json: schema: $ref: '#/components/schemas/Group' MapStringIntegerResponse: description: returns Map content: application/json: schema: type: object additionalProperties: type: integer ExceptionResponse: description: exception occurred content: application/json: schema: $ref: '#/components/schemas/PerunException' ListOfGroupsResponse: description: returns List content: application/json: schema: type: array items: $ref: '#/components/schemas/Group' ListOfMembersResponse: description: returns List content: application/json: schema: type: array items: $ref: '#/components/schemas/Member' MemberResponse: description: returns Member content: application/json: schema: $ref: '#/components/schemas/Member' ListOfRichGroupsResponse: description: returns List content: application/json: schema: type: array items: $ref: '#/components/schemas/RichGroup' RichGroupResponse: description: returns RichGroup content: application/json: schema: $ref: '#/components/schemas/RichGroup' IntegerResponse: description: returns Integer content: application/json: schema: type: integer BooleanResponse: description: returns Boolean content: application/json: schema: type: boolean ListOfRichMembersResponse: description: returns List content: application/json: schema: type: array items: $ref: '#/components/schemas/RichMember' securitySchemes: BasicAuth: description: HTTP Basic authentication with username and password type: http scheme: basic BearerAuth: description: 'OAuth2 Resource Server authentication using access token in ''Authorization: Bearer'' HTTP header' type: http scheme: bearer x-refined-from: - cesnet-perun-rpc-openapi.yml - cesnet-perun-rpc-openapi.yml