openapi: 3.2.0 info: title: Cesnet Members Manager API version: 0.0.0 contact: url: https://perun-aai.org email: perun@cesnet.cz description: 'Operations tagged MembersManager 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: MembersManager description: MembersManager RPC API in Perun externalDocs: url: https://perun-aai.org/documentation/technical-documentation/rpc-api/rpc-javadoc-MembersManager.html paths: /json/membersManager/getMemberById: get: tags: - MembersManager operationId: getMemberById summary: Returns Member by its id description: Gets Member parameters: - $ref: '#/components/parameters/id' 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/membersManager/getRichMemberByUserUUID: get: tags: - MembersManager operationId: getRichMemberByUserUUID summary: Returns RichMember with attributes by the users' uuid and the vo description: Gets RichMember by uuid parameters: - $ref: '#/components/parameters/voId' - $ref: '#/components/parameters/userUuid' - $ref: '#/components/parameters/attrNamesOptional' responses: '200': $ref: '#/components/responses/RichMemberResponse' 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/membersManager/getMembersByIds: get: tags: - MembersManager operationId: getMembersByIds summary: Returns list of Members by their ids parameters: - $ref: '#/components/parameters/ids' 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/membersManager/getRichMembersByIds: get: tags: - MembersManager operationId: getRichMembersByIds summary: Returns rich members by their IDs with specific attributes. parameters: - $ref: '#/components/parameters/ids' - $ref: '#/components/parameters/attrNamesOptional' 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/membersManager/getRichMember: get: tags: - MembersManager operationId: getRichMember summary: Returns RichMember by member id description: Get RichMember without attributes parameters: - $ref: '#/components/parameters/id' responses: '200': $ref: '#/components/responses/RichMemberResponse' 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/membersManager/getRichMemberWithAttributes: get: tags: - MembersManager operationId: getRichMemberWithAttributes summary: Returns Member by its id description: Get richMember with member/user attributes parameters: - $ref: '#/components/parameters/id' responses: '200': $ref: '#/components/responses/RichMemberResponse' 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/membersManager/getRichMembersNoUserAttributes: get: tags: - MembersManager operationId: getRichMembersNoUserAttributes summary: Returns list of all RichMembers for specified VO. description: Get richMembers for VO with member attributes (without user attributes). parameters: - $ref: '#/components/parameters/voId' 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/membersManager/getMemberByUser: get: tags: - MembersManager operationId: getMemberByUser summary: Returns a Member specified by VO id and User id parameters: - $ref: '#/components/parameters/voId' - $ref: '#/components/parameters/userId' 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/membersManager/getMemberByUserIfExists: get: tags: - MembersManager operationId: getMemberByUserIfExists summary: Returns a Member specified by VO id and User ID. parameters: - $ref: '#/components/parameters/voId' - $ref: '#/components/parameters/userId' 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/membersManager/getMembersByUser: get: tags: - MembersManager operationId: getMembersByUser summary: Returns members for a user parameters: - $ref: '#/components/parameters/userId' 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/membersManager/getAllMembers: get: tags: - MembersManager operationId: getAllMembers summary: Get all members from all vos 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/membersManager/getMembers: get: tags: - MembersManager operationId: getMembers summary: Returns members of a VO parameters: - $ref: '#/components/parameters/voId' - name: status in: query required: false schema: $ref: '#/components/schemas/VoMemberStatuses' description: optional status 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/membersManager/findMembersInVo: get: tags: - MembersManager operationId: findMembersInVo summary: Searches for members in a VO parameters: - $ref: '#/components/parameters/voId' - $ref: '#/components/parameters/searchString' 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/membersManager/getMemberByExtSourceNameAndExtLogin: get: tags: - MembersManager operationId: getMemberByExtSourceNameAndExtLogin summary: Searches for members in a VO parameters: - $ref: '#/components/parameters/voId' - $ref: '#/components/parameters/extLogin' - $ref: '#/components/parameters/extSourceName' 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/membersManager/validateMemberAsync: post: tags: - MembersManager operationId: validateMemberAsync summary: Validate all attributes for member and set member's status to VALID. parameters: - $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 /urlinjsonout/membersManager/extendMembership: post: tags: - MembersManager operationId: extendMembership summary: Extend member membership using membershipExpirationRules attribute defined at VO parameters: - $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 /json/membersManager/canExtendMembership: get: tags: - MembersManager operationId: canExtendMembership summary: Return true if the membership can be extended or if no rules were set for the… parameters: - $ref: '#/components/parameters/memberId' 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/membersManager/canExtendInNewRegistrar: get: tags: - MembersManager operationId: canExtendInNewRegistrar summary: Return true if the membership can be extended or if no rules were set for the… parameters: - $ref: '#/components/parameters/memberId' 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/membersManager/canCallerBeMemberWithReason: get: tags: - MembersManager operationId: canCallerBeMemberWithReason summary: Checks if the caller can apply for membership in VO, throws error containing… parameters: - $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/membersManager/getMembersCount: get: tags: - MembersManager operationId: getMembersCount summary: Returns count of all VO members parameters: - $ref: '#/components/parameters/voId' 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/membersManager/getMembersCount/status: get: tags: - MembersManager operationId: getMembersWithStatusCount summary: Returns count of VO members with specified status parameters: - $ref: '#/components/parameters/voId' - name: status description: status (VALID | INVALID | EXPIRED | DISABLED) schema: type: string in: query required: true 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/membersManager/getSponsoredMembers/v: get: tags: - MembersManager operationId: getSponsoredMembers summary: Gets members from VO who are sponsored parameters: - $ref: '#/components/parameters/voId' 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/membersManager/getAllSponsoredMembers: get: tags: - MembersManager operationId: getAllSponsoredMembers summary: Gets all sponsored members from VO parameters: - $ref: '#/components/parameters/voId' 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/membersManager/getSponsors/member: get: tags: - MembersManager operationId: getSponsorsByMember summary: Gets sponsors for given member with optional attribute names parameters: - $ref: '#/components/parameters/memberId' - $ref: '#/components/parameters/attrNamesOptional' responses: '200': $ref: '#/components/responses/ListOfRichUsersResponse' 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/membersManager/getSponsors/vo: get: tags: - MembersManager operationId: getSponsorsByVo summary: Gets sponsors for given VO, extSourceName and extLogin with optional attribute… parameters: - $ref: '#/components/parameters/voId' - $ref: '#/components/parameters/extSourceName' - $ref: '#/components/parameters/extLogin' - $ref: '#/components/parameters/attrNamesOptional' responses: '200': $ref: '#/components/responses/ListOfRichUsersResponse' 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/membersManager/getSponsoredMembersAndTheirSponsors: get: tags: - MembersManager operationId: getSponsoredMembersAndTheirSponsors summary: Gets list of members with sponsors parameters: - $ref: '#/components/parameters/voId' - $ref: '#/components/parameters/attrNames' responses: '200': $ref: '#/components/responses/ListOfMemberWithSponsorsResponse' 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/membersManager/getAllSponsoredMembersAndTheirSponsors: get: tags: - MembersManager operationId: getAllSponsoredMembersAndTheirSponsors summary: Gets list of VO's all sponsored members with sponsors parameters: - $ref: '#/components/parameters/voId' - $ref: '#/components/parameters/attrNames' responses: '200': $ref: '#/components/responses/ListOfMemberWithSponsorsResponse' 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/membersManager/createSponsoredMember/withFullName: post: tags: - MembersManager operationId: createSponsoredMember summary: Creates a new sponsored member in a given VO and namespace responses: '200': $ref: '#/components/responses/RichMemberResponse' default: $ref: '#/components/responses/ExceptionResponse' requestBody: required: true content: application/json: schema: title: InputCreateSponsoredMember description: input for createSponsoredMember type: object required: - userData - vo - sponsor properties: vo: type: integer validityTo: type: string sponsor: type: integer sendActivationLink: type: boolean language: type: string userData: $ref: '#/components/schemas/SponsoredUserData' baseUrl: type: string description: base url of Perun instance (optional) 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/membersManager/setSponsoredMember: post: tags: - MembersManager operationId: setSponsoredMember summary: Creates a sponsored membership for the given user responses: '200': $ref: '#/components/responses/RichMemberResponse' default: $ref: '#/components/responses/ExceptionResponse' requestBody: required: true content: application/json: schema: title: InputSetSponsoredMember description: input for setSponsoredMember type: object required: - userToBeSponsored - password - vo - namespace properties: userToBeSponsored: type: integer password: type: string vo: type: integer sponsor: type: integer namespace: type: string validityTo: type: string 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/membersManager/createSponsoredMembersFromCSV: post: tags: - MembersManager operationId: createSponsoredMembersFromCSV summary: Creates new sponsored members in a given VO and namespace responses: '200': $ref: '#/components/responses/ListOfMapStringStringResponse' default: $ref: '#/components/responses/ExceptionResponse' requestBody: required: true content: application/json: schema: title: InputCreateSponsoredMemberFromCSV description: input for createSponsoredMembersFromCSV type: object required: - vo - sponsor - namespace - data - header properties: data: type: array items: type: string description: values separated with semicolons header: type: string description: csv header for the given data, values are also split with semicolons vo: type: integer sponsor: type: integer namespace: type: string validityTo: type: string sendActivationLinks: type: boolean language: type: string groups: type: array items: type: integer description: groups to which should be the created users assigned baseUrl: type: string description: base url of Perun instance (optional) 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/membersManager/createSponsoredMembers: post: tags: - MembersManager operationId: createSponsoredMembers summary: Creates new sponsored members in a given VO and namespace responses: '200': $ref: '#/components/responses/ListOfMapStringStringResponse' default: $ref: '#/components/responses/ExceptionResponse' requestBody: required: true content: application/json: schema: title: InputCreateSponsoredMembers description: input for createSponsoredMembers type: object required: - guestNames - vo - sponsor - namespace properties: guestNames: type: array items: type: string description: names of members to create, single name should have the format {firstName};{lastName} to be parsed well vo: type: integer sponsor: type: integer namespace: type: string validityTo: type: string email: type: string sendActivationLink: type: boolean language: type: string baseUrl: type: string description: base url of Perun instance (optional) 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/membersManager/createSpecificMember: post: tags: - MembersManager operationId: createSpecificMember summary: Creates a new member from candidate which is prepared for creating specificUser responses: '200': $ref: '#/components/responses/MemberResponse' default: $ref: '#/components/responses/ExceptionResponse' requestBody: required: true content: application/json: schema: title: InputSpecificMember description: input to createSpecificMember type: object required: - candidate - vo - specificUserType - specificUserOwners properties: candidate: $ref: '#/components/schemas/Candidate' vo: type: integer specificUserType: type: string specificUserOwners: type: array items: $ref: '#/components/schemas/User' 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/membersManager/removeSponsor: post: tags: - MembersManager operationId: removeSponsor summary: Removes sponsor of existing member parameters: - $ref: '#/components/parameters/memberId' - $ref: '#/components/parameters/sponsorId' 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/membersManager/removeSponsors: post: tags: - MembersManager operationId: removeSponsors summary: Removes sponsors of existing member parameters: - $ref: '#/components/parameters/memberId' - name: sponsorIds description: list of ids of sponsors schema: type: array items: 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/membersManager/updateSponsorshipValidity: post: tags: - MembersManager operationId: updateSponsorshipValidity summary: Updates sponsorship validity. parameters: - $ref: '#/components/parameters/memberId' - $ref: '#/components/parameters/sponsorId' - $ref: '#/components/parameters/optionalValidityTo' 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/membersManager/deleteMember: post: tags: - MembersManager operationId: deleteMember summary: Deletes only member data appropriated by member id parameters: - $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/membersManager/deleteMembers: post: tags: - MembersManager operationId: deleteMembers summary: Delete members with given ids. parameters: - $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/membersManager/deleteMembers: post: tags: - MembersManager operationId: deleteMembersBodyParams summary: Delete members with given ids. requestBody: required: true content: application/json: schema: title: InputDeleteMembers description: input to delete members type: object required: - members properties: members: type: array items: type: integer 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/membersManager/findCompleteRichMembers/v: get: tags: - MembersManager operationId: FindCompleteRichMembersForVo summary: Return list of richMembers for specific vo by the searchString with attributes… parameters: - $ref: '#/components/parameters/voId' - $ref: '#/components/parameters/attrsNames' - $ref: '#/components/parameters/listOfAllowedStatuses' - $ref: '#/components/parameters/searchString' 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/membersManager/findCompleteRichMembers/v-sponsored: get: tags: - MembersManager operationId: findSponsoredCompleteRichMembersForVo summary: Returns list of RichMembers for vo, with reqested attributes, filterd by search… parameters: - $ref: '#/components/parameters/voId' - $ref: '#/components/parameters/attrsNames' - $ref: '#/components/parameters/searchString' - $ref: '#/components/parameters/onlySponsored' 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/membersManager/findCompleteRichMembers/g: get: tags: - MembersManager operationId: FindCompleteRichMembersForGroup summary: Return list of richMembers for specific group by the searchString with… parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/attrsNames' - $ref: '#/components/parameters/listOfAllowedStatuses' - $ref: '#/components/parameters/listOfAllowedGroupStatuses' - $ref: '#/components/parameters/searchString' - $ref: '#/components/parameters/lookingInParentGroup' 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/membersManager/findCompleteRichMembers/attrs: get: tags: - MembersManager operationId: FindCompleteRichMembersByAttributes summary: Return list of richMembers from perun by the searchString with attributes… parameters: - $ref: '#/components/parameters/attrsNames' - $ref: '#/components/parameters/searchString' - $ref: '#/components/parameters/listOfAllowedStatuses' 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/membersManager/createMember/extSource: post: tags: - MembersManager operationId: createMemberFromExtSource summary: Creates a new member and sets all member's attributes from the candidate. responses: '200': $ref: '#/components/responses/MemberResponse' default: $ref: '#/components/responses/ExceptionResponse' requestBody: required: true content: application/json: schema: title: InputCreateMemberFromExtSource description: input to create member from extSource type: object required: - vo - extSourceName - extSourceType - login - candidate properties: vo: type: integer extSourceName: type: string extSourceType: type: string login: type: string candidate: $ref: '#/components/schemas/Candidate' groups: type: array items: $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/membersManager/createMember/u: post: tags: - MembersManager operationId: CreateMemberForUser summary: Creates a new member from user. responses: '200': $ref: '#/components/responses/MemberResponse' default: $ref: '#/components/responses/ExceptionResponse' requestBody: required: true content: application/json: schema: title: InputCreateMemberForUser description: input to create member for user type: object required: - vo - user properties: vo: type: integer user: type: integer groups: type: array items: $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/membersManager/createMember/c: post: tags: - MembersManager operationId: createMemberForCandidate summary: Creates a new member from candidate returned by the method… responses: '200': $ref: '#/components/responses/MemberResponse' default: $ref: '#/components/responses/ExceptionResponse' requestBody: required: true content: application/json: schema: title: InputCreateMemberForCandidate description: input to create member for candidate type: object required: - vo - candidate properties: vo: type: integer candidate: $ref: '#/components/schemas/Candidate' groups: type: array items: $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/membersManager/getCompleteRichMembers/v: get: tags: - MembersManager operationId: getCompleteRichMembersForVo summary: Get all RichMembers with attributes specific for list of attrsNames from the vo… parameters: - $ref: '#/components/parameters/voId' - $ref: '#/components/parameters/listOfAllowedStatuses' - name: attrsNames[] description: list of attributes names List in: query required: false schema: type: array items: type: string 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/membersManager/getCompleteRichMembers/g: get: tags: - MembersManager operationId: getCompleteRichMembersForGroup summary: Get all RichMembers with attributes specific for list of attrsNames from the… parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/listOfAllowedStatuses' - $ref: '#/components/parameters/listOfAllowedGroupStatuses' - $ref: '#/components/parameters/lookingInParentGroup' - name: attrsNames[] description: list of attributes names List in: query required: false schema: type: array items: type: string 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/membersManager/getCompleteRichMembers/g-r: get: tags: - MembersManager operationId: getCompleteRichMembersForGroupResource summary: Get all RichMembers with attributes specific for list of attrsNames. parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/resourceId' - $ref: '#/components/parameters/attrsNames' - name: allowedStatuses[] description: list of allowed statuses List in: query required: true schema: type: array items: type: string 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/membersManager/getServiceUserRichMembers: get: tags: - MembersManager operationId: getServiceUserRichMembers summary: Retrieve service user RichMembers from a VO parameters: - $ref: '#/components/parameters/voId' 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 /urlinjsonout/membersManager/setStatus: post: tags: - MembersManager operationId: setStatus summary: Set membership status of a member parameters: - $ref: '#/components/parameters/memberId' - name: status description: status (VALID | INVALID | EXPIRED | DISABLED) 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/membersManager/sendUsernameReminderEmail: post: tags: - MembersManager operationId: sendUsernameReminderEmail summary: Send mail to user's preferred email address with a reminder of the username for… parameters: - $ref: '#/components/parameters/memberId' - $ref: '#/components/parameters/namespace' - name: emailAttributeURN schema: type: string in: query required: true description: urn of the attribute with stored mail - name: language schema: type: string in: query required: true description: language of the message 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/membersManager/sendPasswordResetLinkEmail: post: tags: - MembersManager operationId: sendPasswordResetLinkEmail summary: Send mail to user's preferred email address with link for non-authz password… parameters: - $ref: '#/components/parameters/memberId' - $ref: '#/components/parameters/namespace' - name: emailAttributeURN schema: type: string in: query required: true description: urn of the attribute with stored mail - name: language schema: type: string in: query required: true description: language of the message - name: baseUrl schema: type: string in: query required: false description: base url of Perun instance (optional) 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/membersManager/sendAccountActivationLinkEmail: post: tags: - MembersManager operationId: sendAccountActivationLinkEmail summary: Send mail to user's preferred email address with link for non-authz account… parameters: - $ref: '#/components/parameters/memberId' - $ref: '#/components/parameters/namespace' - name: emailAttributeURN schema: type: string in: query required: true description: urn of the attribute with stored mail - name: language schema: type: string in: query required: true description: language of the message - name: baseUrl schema: type: string in: query required: false description: base url of Perun instance (optional) 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/membersManager/setSponsorshipForMember: post: tags: - MembersManager operationId: setSponsorshipForMember summary: Transform non-sponsored member to sponsored one, with defined sponsor and… parameters: - $ref: '#/components/parameters/sponsoredMemberId' - $ref: '#/components/parameters/sponsorId' - $ref: '#/components/parameters/optionalValidityTo' responses: '200': $ref: '#/components/responses/RichMemberResponse' 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/membersManager/sponsorMember: post: tags: - MembersManager operationId: sponsorMember summary: For an existing member, assigns a new sponsor parameters: - $ref: '#/components/parameters/memberId' - $ref: '#/components/parameters/sponsorId' - $ref: '#/components/parameters/optionalValidityTo' responses: '200': $ref: '#/components/responses/RichMemberResponse' 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/membersManager/sponsorMembers: post: tags: - MembersManager operationId: sponsorMembers summary: Assigns a new sponsor to existing members. parameters: - $ref: '#/components/parameters/memberIds' - $ref: '#/components/parameters/sponsorId' - $ref: '#/components/parameters/optionalValidityTo' 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/membersManager/sponsorMembers: post: tags: - MembersManager operationId: sponsorMembersBodyParams summary: Assigns a new sponsor to existing members. responses: '200': $ref: '#/components/responses/VoidResponse' default: $ref: '#/components/responses/ExceptionResponse' requestBody: required: true content: application/json: schema: title: InputSponsorMembers description: input to sponsor members type: object required: - members - sponsor properties: members: type: array items: type: integer sponsor: type: integer validityTo: type: string 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/membersManager/copySponsoredMembers: post: tags: - MembersManager operationId: copySponsoredMembers summary: Copy sponsored members from one user to another. parameters: - $ref: '#/components/parameters/memberIds' - name: copyFrom schema: type: integer in: query description: id of source sponsor required: true - name: copyTo schema: type: integer in: query description: id of target sponsor required: true - name: copyValidity schema: type: boolean in: query description: whether to copy validity required: true - $ref: '#/components/parameters/optionalValidityTo' 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/membersManager/copySponsoredMembers: post: tags: - MembersManager operationId: copySponsoredMembersBodyParams summary: Copy sponsored members from one user to another. responses: '200': $ref: '#/components/responses/VoidResponse' default: $ref: '#/components/responses/ExceptionResponse' requestBody: required: true content: application/json: schema: title: InputCopySponsoredMembers description: input to copy sponsored members type: object required: - members - copyFrom - copyTo - copyValidity properties: members: type: array items: type: integer copyFrom: type: integer copyTo: type: integer copyValidity: type: boolean validityTo: type: string 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/membersManager/moveMembership: post: tags: - MembersManager operationId: moveMembership summary: Moves membership in VO from source user to target user - moves the source… parameters: - $ref: '#/components/parameters/voId' - name: sourceUser schema: type: integer in: query description: id of source user required: true - name: targetUser schema: type: integer in: query description: id of target user 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 /json/membersManager/getAllNamespacesRules: get: tags: - MembersManager operationId: getAllNamespacesRules summary: Return all loaded namespaces rules responses: '200': $ref: '#/components/responses/ListOfNamespacesRulesResponse' 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/membersManager/getMembersPage: post: tags: - MembersManager operationId: getMembersPage summary: Get page of members from the given vo, with the given attributes responses: '200': $ref: '#/components/responses/PaginatedRichMembersResponse' default: $ref: '#/components/responses/ExceptionResponse' requestBody: required: true content: application/json: schema: title: InputGetPaginatedMembers description: input to getPaginatedMembers type: object required: - vo - query - attrNames properties: vo: type: integer attrNames: type: array items: type: string query: $ref: '#/components/schemas/MembersPageQuery' 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/membersManager/addMemberCandidates: post: tags: - MembersManager operationId: addMemberCandidates summary: Adds member candidates responses: '200': $ref: '#/components/responses/VoidResponse' default: $ref: '#/components/responses/ExceptionResponse' requestBody: required: true content: application/json: schema: title: InputAddMemberCandidates description: input to add member candidates type: object required: - vo - candidates properties: vo: type: integer candidates: type: array items: $ref: '#/components/schemas/MemberCandidate' group: 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 /json/membersManager/someAvailableSponsorExistsForMember: get: tags: - MembersManager operationId: someAvailableSponsorExistsForMember summary: Returns true if some vo sponsor who does not already sponsor given member… parameters: - $ref: '#/components/parameters/memberId' 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/membersManager/getAvailableSponsorsForMember: get: tags: - MembersManager operationId: getAvailableSponsorsForMember summary: Returns all available sponsors for given member parameters: - $ref: '#/components/parameters/memberId' responses: '200': $ref: '#/components/responses/ListOfUsersResponse' 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/membersManager/createMemberFromInitialRegistrarApplication: post: tags: - MembersManager operationId: createMemberFromInitialRegistrarApplication summary: Creates a member based on data from an initial registrar application description: Creates a member based on a registrar application with OIDC authentication. responses: '200': $ref: '#/components/responses/MemberResponse' default: $ref: '#/components/responses/ExceptionResponse' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RegistrarApplicationInput' 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/membersManager/extendMembershipFromExtensionRegistrarApplication: post: tags: - MembersManager operationId: extendMembershipFromExtensionRegistrarApplication summary: Extends a membership based on data from an initial registrar application description: Extends a membership based on a registrar application with OIDC authentication. responses: '200': $ref: '#/components/responses/MemberResponse' default: $ref: '#/components/responses/ExceptionResponse' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RegistrarApplicationInput' 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: extLogin: name: extLogin description: external login of user, e.g. john schema: type: string in: query required: true attrNamesOptional: name: attrNames[] description: list of attribute names List or null in: query required: false schema: type: array items: type: string listOfAllowedGroupStatuses: name: allowedGroupStatuses[] description: list of allowed group statuses List in: query required: false schema: type: array items: type: string enum: - VALID - EXPIRED voId: name: vo description: id of Vo schema: type: integer in: query required: true userId: name: user description: id of User schema: type: integer in: query required: true listOfAllowedStatuses: name: allowedStatuses[] description: list of allowed statuses List in: query required: false schema: type: array items: type: string ids: name: ids[] description: list of ids List in: query required: true schema: type: array items: type: integer 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 namespace: name: namespace description: namespace schema: type: string in: query required: true sponsoredMemberId: name: sponsoredMember description: id of member to be sponsored schema: type: integer in: query required: true userUuid: name: uuid description: uuid of User schema: type: string format: uuid in: query required: true sponsorId: name: sponsor description: id of sponsor schema: type: integer 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 extSourceName: name: extSourceName description: external source name, e.g. IdP entityId schema: type: string in: query required: true resourceId: name: resource description: id of Resource schema: type: integer in: query required: true searchString: name: searchString description: Text to search by schema: type: string in: query required: true optionalValidityTo: name: validityTo description: date in format yyyy-mm-dd schema: type: - string - 'null' in: query required: false attrsNames: name: attrsNames[] description: list of attribute names List in: query required: true schema: type: array items: type: string id: name: id description: numeric id schema: type: integer in: query required: true onlySponsored: name: onlySponsored description: Boolean specifying if only sponsored members should be returned schema: type: boolean in: query required: true lookingInParentGroup: name: lookingInParentGroup description: If true, look up in a parent group schema: type: boolean in: query required: true schemas: RegistrarApplicationInput: title: RegistrarApplicationInput description: input for registrar application endpoints type: object required: - vo - attributes - oidcAttributes properties: vo: type: integer description: ID of the Virtual Organization group: type: - integer - 'null' description: ID of the Group to add the member to (optional, null for VO applications) attributes: type: object additionalProperties: type: string description: 'Map of the application attributes (key: attr name, value: attr value)' oidcAttributes: type: object additionalProperties: type: string description: Map of OIDC attributes (must contain iss and sub claims) Candidate: allOf: - $ref: '#/components/schemas/User' properties: userExtSource: $ref: '#/components/schemas/UserExtSource' additionalUserExtSources: type: array items: $ref: '#/components/schemas/UserExtSource' attributes: type: object additionalProperties: type: string expectedSyncGroupStatus: type: string 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 VoMemberStatuses: type: string description: statuses of a member in a Vo enum: - VALID - INVALID - EXPIRED - DISABLED MembersOrderColumn: type: string enum: - ID - NAME - EMAIL - GROUP_STATUS - STATUS - ORGANIZATION Sponsor: description: represents a Sponsor for some specific member type: object properties: user: $ref: '#/components/schemas/User' userExtSources: type: array items: $ref: '#/components/schemas/UserExtSource' userAttributes: type: array items: $ref: '#/components/schemas/Attribute' validityTo: type: string description: Date in format yyyy-MM-dd} active: type: boolean required: - user - userExtSources - userAttributes - validityTo - active MemberGroupStatus: type: string description: statuses of a member in a group enum: - VALID - EXPIRED SponsoredUserData: type: object properties: guestName: type: string firstName: type: string lastName: type: string titleBefore: type: string titleAfter: type: string namespace: type: string email: type: string password: type: string login: type: string RichUser: description: user data packed together with all user attributes and UserExtSources allOf: - $ref: '#/components/schemas/User' properties: userExtSources: type: - array - 'null' items: $ref: '#/components/schemas/UserExtSource' userAttributes: type: - array - 'null' items: $ref: '#/components/schemas/Attribute' required: - userExtSources - userAttributes PaginatedRichMembers: properties: offset: type: integer pageSize: type: integer totalCount: type: integer data: type: array items: $ref: '#/components/schemas/RichMember' required: - offset - pageSize - totalCount - data MemberWithSponsors: type: object properties: member: $ref: '#/components/schemas/RichMember' sponsors: type: array items: $ref: '#/components/schemas/Sponsor' NamespaceRules: type: object properties: defaultEmail: type: string csvGenHeader: type: string csvGenPlaceholder: type: string csvGenHeaderDescription: type: string namespaceName: type: string requiredAttributes: type: array items: type: string optionalAttributes: type: array items: type: string required: - namespaceName 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 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 MemberCandidate: type: object properties: candidate: $ref: '#/components/schemas/Candidate' member: $ref: '#/components/schemas/Member' richUser: $ref: '#/components/schemas/RichUser' 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' MembersPageQuery: properties: pageSize: type: integer offset: type: integer order: $ref: '#/components/schemas/SortingOrder' sortColumn: $ref: '#/components/schemas/MembersOrderColumn' searchString: type: string statuses: type: array items: $ref: '#/components/schemas/VoMemberStatuses' groupId: type: integer groupStatuses: type: array items: $ref: '#/components/schemas/MemberGroupStatus' required: - pageSize - offset - order - sortColumn SortingOrder: type: string enum: - ASCENDING - DESCENDING 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 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 Attribute: allOf: - $ref: '#/components/schemas/AttributeDefinition' properties: valueCreatedAt: type: - string - 'null' valueCreatedBy: type: - string - 'null' valueModifiedAt: type: - string - 'null' valueModifiedBy: type: - string - 'null' value: {} responses: PaginatedRichMembersResponse: description: returns Paginated content: application/json: schema: $ref: '#/components/schemas/PaginatedRichMembers' ListOfNamespacesRulesResponse: description: returns List content: application/json: schema: type: array items: $ref: '#/components/schemas/NamespaceRules' VoidResponse: description: returns nothing ExceptionResponse: description: exception occurred content: application/json: schema: $ref: '#/components/schemas/PerunException' ListOfMapStringStringResponse: description: returns List> content: application/json: schema: type: array items: type: object additionalProperties: type: string ListOfMembersResponse: description: returns List content: application/json: schema: type: array items: $ref: '#/components/schemas/Member' RichMemberResponse: description: returns RichMember content: application/json: schema: $ref: '#/components/schemas/RichMember' ListOfUsersResponse: description: returns List content: application/json: schema: type: array items: $ref: '#/components/schemas/User' MemberResponse: description: returns Member content: application/json: schema: $ref: '#/components/schemas/Member' 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' ListOfRichUsersResponse: description: returns List content: application/json: schema: type: array items: $ref: '#/components/schemas/RichUser' ListOfMemberWithSponsorsResponse: description: returns List content: application/json: schema: type: array items: $ref: '#/components/schemas/MemberWithSponsors' 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