RPC API documentation v34.4.0

Add new mail notification.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/addApplicationMail

• see URL structure

Example params

{ "vo" : 86 , "mail" : {...} }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Add new mail notification.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/addApplicationMail

• see URL structure

Example params

{ "group" : 70 , "mail" : {...} }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Adds a new item to a form.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/addFormItem

• see URL structure

Example params

{ "vo" : 54 , "item" : { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER",  "beanName" : "ApplicationFormItem" } }

• see Passing params

Example response

{ "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER",  "beanName" : "ApplicationFormItem" }

• see Return values
• see HTTP return codes

Adds a new item to a form.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/addFormItem

• see URL structure

Example params

{ "group" : 4 , "item" : { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER",  "beanName" : "ApplicationFormItem" } }

• see Passing params

Example response

{ "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER",  "beanName" : "ApplicationFormItem" }

• see Return values
• see HTTP return codes

Adds groups to a list of groups which can be registered into during vo registration.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/addGroupsToAutoRegistration

• see URL structure

Example params

{ "ids" : [ 51 , 32 ] }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Adds groups to a list of groups which can be registered into during vo registration and are representing options for a particular form item.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/addGroupsToAutoRegistration

• see URL structure

Example params

{ "ids" : [ 77 , 51 ] , "formItem" : 30 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Adds groups to a list of groups which can be registered into during group registration and are representing options for a particular form item. group

Example URL

https://[hostname]/krb/rpc/json/registrarManager/addGroupsToAutoRegistration

• see URL structure

Example params

{ "ids" : [ 91 , 86 ] , "registrationGroup" : {...} , "formItem" : 93 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Manually approves an application. Expected to be called as a result of direct VO administrator action in the web UI.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/approveApplication

• see URL structure

Example params

{ "id" : 76 }

• see Passing params

Example response

{ "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" }

• see Return values
• see HTTP return codes

Manually approve multiple applications at once. Expected to be called as a result of direct VO administrator action in the web UI.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/approveApplications

• see URL structure

Example params

{ "ids" : [ 27 , 0 ] }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Creates an invitation link for the given Vo with the default authType (if defined in the Vo attribute)

Example URL

https://[hostname]/krb/rpc/json/registrarManager/buildInviteURL

• see URL structure

Example params

{ "voId" : 15 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Creates an invitation link for the given group with the default authType (if defined in the Group attribute)

Example URL

https://[hostname]/krb/rpc/json/registrarManager/buildInviteURL

• see URL structure

Example params

{ "voId" : 78 , "groupId" : 65 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Check if application can be approved based on form module rules. Throws exception if not. Expected to be called from Web UI before actual approving happens, so VO admin can override this default behavior.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/canBeApproved

• see URL structure

Example params

{ "id" : 78 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Checks whether input is valid html for application form item checkbox labels

Example URL

https://[hostname]/krb/rpc/json/registrarManager/checkCheckboxHtml

• see URL structure

Example params

{ "html" : "text" }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Check for similar users by name and email in session (authz) information

Example URL

https://[hostname]/krb/rpc/json/registrarManager/checkForSimilarRichIdentities

• see URL structure

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Check if new application may belong to another user in Perun (but same person in real life). Return list of similar identities (by external identity, name or email). Returned identities contain also organization, email and external identities.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/checkForSimilarUsers

• see URL structure

Example params

{ "appId" : 82 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Check if new application may belong to another user in Perun (but same person in real life). IMPORTANT: This check is performed only on latest application of specified vo/group and type which belongs to logged in user/identity. Return list of similar identities (by external identity, name or email). Returned identities contain also organization, email and external identities.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/checkForSimilarUsers

• see URL structure

Example params

{ "voId" : 60 , "groupId" : 62 , "type" : "text" }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Check for similar users by name and email in session (authz) information

Example URL

https://[hostname]/krb/rpc/json/registrarManager/checkForSimilarUsers

• see URL structure

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Check if newly inserted form data may connect anonymous person to existing user. Return list of similar users (by identity, name or email). Returned users contain also organization and preferredMail attribute.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/checkForSimilarUsers

• see URL structure

Example params

{ "formItems" : [ { "id" : 12 , "forItem" : { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER",  "beanName" : "ApplicationFormItem" } , "shortName" : "form data name" , "value" : "test value" , "assuranceLevel" : "0" , "beanName" : "ApplicationFormItemData" } , {...} , {...} ] }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Checks whether input is valid html according to the rules in our custom html parser

Example URL

https://[hostname]/krb/rpc/json/registrarManager/checkHtmlInput

• see URL structure

Example params

{ "html" : "text" }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Join user identities by access tokens. (already joined). order to join two user accounts contact support.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/consolidate

• see URL structure

Example params

{ "accessToken" : {...} }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Join current user identity (authz) with the one previously provided and referenced by the token. (already joined). order to join two user accounts contact support.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/consolidateIdentityUsingToken

• see URL structure

Example params

{ "token" : "text" }

• see Passing params

Example response

[ { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Copy all form items from selected VO into another.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/copyForm

• see URL structure

Example params

{ "fromVo" : 91 , "toVo" : 44 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Copy all form items from selected Group into another.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/copyForm

• see URL structure

Example params

{ "fromGroup" : 70 , "toGroup" : 30 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Copy all form items from selected VO into Group.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/copyForm

• see URL structure

Example params

{ "fromVO" : 82 , "toGroup" : 86 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Copy all form items from selected Group into VO.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/copyForm

• see URL structure

Example params

{ "fromGroup" : 99 , "toVO" : 39 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Copy all e-mail notifications from selected VO into another.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/copyMails

• see URL structure

Example params

{ "fromVo" : 60 , "toVo" : 16 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Copy all e-mail notifications from selected Group into another.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/copyMails

• see URL structure

Example params

{ "fromGroup" : 41 , "toGroup" : 89 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Copy all e-mail notifications from selected VO into Group.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/copyMails

• see URL structure

Example params

{ "fromVo" : 86 , "toGroup" : 23 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Copy all e-mail notifications from selected Group into VO.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/copyMails

• see URL structure

Example params

{ "fromGroup" : 31 , "toVO" : 63 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Creates a new application. The method triggers approval for VOs with auto-approved applications.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/createApplication

• see URL structure

Example params

{ "app" : { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , "data" : [ { "id" : 12 , "forItem" : { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER",  "beanName" : "ApplicationFormItem" } , "shortName" : "form data name" , "value" : "test value" , "assuranceLevel" : "0" , "beanName" : "ApplicationFormItemData" } , {...} , {...} ] }

• see Passing params

Example response

[ { "id" : 12 , "forItem" : { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER",  "beanName" : "ApplicationFormItem" } , "shortName" : "form data name" , "value" : "test value" , "assuranceLevel" : "0" , "beanName" : "ApplicationFormItemData" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Create application form for a VO.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/createApplicationForm

• see URL structure

Example params

{ "vo" : 1 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Create application form for a group.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/createApplicationForm

• see URL structure

Example params

{ "group" : 1 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Deletes an application.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/deleteApplication

• see URL structure

Example params

{ "id" : 70 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Deletes an e-mail notification from DB based on id property.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/deleteApplicationMail

• see URL structure

Example params

{ "vo" : 95 , "id" : 50 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Deletes an e-mail notification from DB based on id property.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/deleteApplicationMail

• see URL structure

Example params

{ "group" : 49 , "id" : 26 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Manually delete multiple applications at once. Expected to be called as a result of direct VO administrator action in the web UI.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/deleteApplications

• see URL structure

Example params

{ "ids" : [ 56 , 8 ] }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Removes a form item permanently. The user data associated with it remains in the database, it just loses the foreign key reference which becomes null.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/deleteFormItem

• see URL structure

Example params

{ "vo" : 50 , "ordnum" : 78 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Removes a form item permanently. The user data associated with it remains in the database, it just loses the foreign key reference which becomes null.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/deleteFormItem

• see URL structure

Example params

{ "group" : 67 , "ordnum" : 81 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Deletes groups from a list of groups which can be registered into during vo registration.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/deleteGroupsFromAutoRegistration

• see URL structure

Example params

{ "ids" : [ 58 , 72 ] }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Deletes groups from a list of groups which can be registered into during vo registration and are representing options for a particular form item.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/deleteGroupsFromAutoRegistration

• see URL structure

Example params

{ "ids" : [ 18 , 84 ] , "formItem" : 29 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Deletes groups from a list of groups which can be registered into during group registration and are representing options for a particular form item. group

Example URL

https://[hostname]/krb/rpc/json/registrarManager/deleteGroupsFromAutoRegistration

• see URL structure

Example params

{ "ids" : [ 25 , 59 ] , "registrationGroup" : {...} , "formItem" : 82 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Returns all groups which can be registered into during any vo registration.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getAllGroupsForAutoRegistration

• see URL structure

Example response

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

• see Return values
• see HTTP return codes

Returns application object by its id.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getApplicationById

• see URL structure

Example params

{ "id" : 56 }

• see Passing params

Example response

{ "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" }

• see Return values
• see HTTP return codes

Returns data submitted by user in given application (by id).

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getApplicationDataById

• see URL structure

Example params

{ "id" : 55 }

• see Passing params

Example response

[ { "id" : 12 , "forItem" : { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER",  "beanName" : "ApplicationFormItem" } , "shortName" : "form data name" , "value" : "test value" , "assuranceLevel" : "0" , "beanName" : "ApplicationFormItemData" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Gets an application form for a given VO. There is exactly one form for membership per VO, one form is used for both initial registration and annual account expansion, just the form items are marked whether the should be present in one, the other, or both types of application.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getApplicationForm

• see URL structure

Example params

{ "vo" : 47 }

• see Passing params

Example response

{ "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "automaticApproval" : true , "automaticApprovalExtension" : true , "moduleClassName" : "cz.metacentrum.perun.core.impl.modules.attributes.VirtualAttributesModule" , "beanName" : "ApplicationForm" }

• see Return values
• see HTTP return codes

Gets an application form for a given Group. There is exactly one form for membership per Group, one form is used for both initial registration and annual account expansion, just the form items are marked whether the should be present in one, the other, or both types of application.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getApplicationForm

• see URL structure

Example params

{ "group" : 4 }

• see Passing params

Example response

{ "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "automaticApproval" : true , "automaticApprovalExtension" : true , "moduleClassName" : "cz.metacentrum.perun.core.impl.modules.attributes.VirtualAttributesModule" , "beanName" : "ApplicationForm" }

• see Return values
• see HTTP return codes

Return mail definition including texts by id.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getApplicationMailById

• see URL structure

Example params

{ "id" : 3 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Returns all mail notifications related to specific app form.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getApplicationMails

• see URL structure

Example params

{ "vo" : 97 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Returns all mail notifications related to specific app form.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getApplicationMails

• see URL structure

Example params

{ "group" : 60 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Gets all applications for a given Group.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getApplicationsForGroup

• see URL structure

Example params

{ "group" : 1 }

• see Passing params

Example response

[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Gets all applications in a given state for a given Group.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getApplicationsForGroup

• see URL structure

Example params

{ "group" : 58 , "state" : [ "text" , "text" ] }

• see Passing params

Example response

[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Gets all applications in a given state for a given Group in a given date period.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getApplicationsForGroup

• see URL structure

Example params

{ "group" : 59 , "state" : [ "text" , "text" ] , "dateFrom" : {...} , "dateTo" : {...} }

• see Passing params

Example response

[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Gets all applications for member

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getApplicationsForMember

• see URL structure

Example params

{ "member" : 81 }

• see Passing params

Example response

[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Gets all applications for member

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getApplicationsForMember

• see URL structure

Example params

{ "member" : 78 , "group" : 89 }

• see Passing params

Example response

[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Gets all applications for the current user based on authz and internal user ID.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getApplicationsForUser

• see URL structure

Example response

[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Gets all applications for a specific user by user ID. Ignores session data.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getApplicationsForUser

• see URL structure

Example params

{ "id" : 35 }

• see Passing params

Example response

[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Gets all applications in a given state for a given VO.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getApplicationsForVo

• see URL structure

Example params

{ "vo" : 60 , "state" : [ "text" , "text" ] }

• see Passing params

Example response

[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Gets all applications in a given state for a given VO in a given date period.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getApplicationsForVo

• see URL structure

Example params

{ "vo" : 26 , "state" : [ "text" , "text" ] , "dateFrom" : {...} , "dateTo" : {...} }

• see Passing params

Example response

[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Get page of applications from the given vo, with the given attributes. Query parameter specifies offset, page size, sorting order, sorting column, statuses of the applications, whether to include group applications if searching only in VO and string to search applications by (by default it searches in group names/descriptions, group and application ids, group uuids, logins of submitters and application_data values), dateFrom and dateTo are optional and specify dates when the applications were submitted, the last 2 parameters are optional and serve to search group/member specific applications.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getApplicationsPage

• see URL structure

Example params

{ "vo" : 49 , "query" : { "pageSize" : 3 , "offset" : 0 , "order" : "ASCENDING" , "sortColumn" : "ID" , "includeGroupApplications" : true , "searchString" : "Doe" , "states" : ["VERIFIED" , "NEW"] , "dateFrom" : "2011-05-17", "dateTo" : "2011-05-17", "memberId" : 10 , "groupId" : 10 } }

• see Passing params

Example response

{ "offset" : 0 , "pageSize" : 3 , "totalCount" : 1 , "data" : [ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "RichApplication", "formData" : [ { "id" : 12 , "forItem" : { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER",  "beanName" : "ApplicationFormItem" } , "shortName" : "form data name" , "value" : "test value" , "assuranceLevel" : "0" , "beanName" : "ApplicationFormItemData" } , {...} , {...} ] } , {...} , {...} ]  }

• see Return values
• see HTTP return codes

Get time-limited token proving user identity in external source (for now 3 minutes). It can be used to join user identity with another by calling consolidateIdentityUsingToken() method and passing the token. Please note, that different authz (identity) must be used to perform both calls.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getConsolidatorToken

• see URL structure

Example response

"text"

• see Return values
• see HTTP return codes

Return form item by its ID, you must be authorized to manipulate the form.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getFormItemById

• see URL structure

Example params

{ "id" : 35 }

• see Passing params

Example response

{ "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER",  "beanName" : "ApplicationFormItem" }

• see Return values
• see HTTP return codes

Gets all items in VO application form.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getFormItems

• see URL structure

Example params

{ "vo" : 64 }

• see Passing params

Example response

[ { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER",  "beanName" : "ApplicationFormItem" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Gets items of specified type in VO application form, for initital registration or extension of account.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getFormItems

• see URL structure

Example params

{ "vo" : 65 , "type" : "text" }

• see Passing params

Example response

[ { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER",  "beanName" : "ApplicationFormItem" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Gets all items in Group application form.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getFormItems

• see URL structure

Example params

{ "group" : 56 }

• see Passing params

Example response

[ { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER",  "beanName" : "ApplicationFormItem" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Gets items of specified type in Group application form, for initital registration or extension of account.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getFormItems

• see URL structure

Example params

{ "group" : 82 , "type" : "text" }

• see Passing params

Example response

[ { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER",  "beanName" : "ApplicationFormItem" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Gets the content for an application form for a given type of application and user. The values are prefilled from database for extension applications, and always from federation values taken from the user argument.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getFormItemsWithPrefilledValues

• see URL structure

Example params

{ "vo" : 3 , "type" : "text" }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Gets the content for an application form for a given type of application and user. The values are prefilled from database for extension applications, and always from federation values taken from the user argument.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getFormItemsWithPrefilledValues

• see URL structure

Example params

{ "group" : 44 , "type" : "text" }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Returns all groups which can be registered into during vo registration.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getGroupsToAutoRegistration

• see URL structure

Example params

{ "vo" : 56 , "formItem" : 97 }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Returns all groups which can be registered into during group registration.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getGroupsToAutoRegistration

• see URL structure

Example params

{ "group" : 99 , "formItem" : 90 }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Gets open applications for the current user based on authz and internal user ID.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getOpenApplicationsForUser

• see URL structure

Example response

[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Gets open applications for a specific user by user ID. Ignores session data.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/getOpenApplicationsForUser

• see URL structure

Example params

{ "id" : 45 }

• see Passing params

Example response

[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , {...} , {...} ]

• see Return values
• see HTTP return codes

Retrieves all necessary data about VO under registrar session.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/initialize

• see URL structure

Example params

{ "voShortName" : "text" }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Retrieves all necessary data about VO and Group under registrar session.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/initialize

• see URL structure

Example params

{ "voShortName" : "text" , "groupName" : "text" }

• see Passing params

Example response

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

• see Return values
• see HTTP return codes

Checks if invitation form and invitation notification exist.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/invitationFormExists

• see URL structure

Example params

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

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Invite member candidates. If candidate contains richUser, then his preferred mail is retrieved and used, otherwise email must be passed in candidate's attributes.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/inviteMemberCandidates

• see URL structure

Example params

{ "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "lang" : {...} , "candidates" : [ { "candidate" : { "id" : 0 , "serviceUser" : false , "firstName" : "Random" , "lastName" : "Name" , "middleName" : null , "titleBefore" : "Dr." , "titleAfter" : null , userExtSource : { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , additionalUserExtSources : null , attributes : { "urn:perun:member:attribute-def:def:organization" : "Masarykova univerzita" , "urn:perun:member:attribute-def:def:mail" : "random@name.cz" } } , "member" : { "id" : 12 , "userId" : 34 , "voId" : 42 , "sourceGroupId" : null , "membershipType" : "DIRECT" , "status" : "VALID" , "sponsored" : false , "beanName" : "Member" } , "richUser" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "RichUser" , "userExtSources" : [ { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , {...} , {...} ], "userAttributes" : [ { "value" : "my_login" , "type" : "java.lang.String" , "entity" : "user" , "namespace" : "urn:perun:user:attribute-def:def" , "friendlyName" : "login-namespace:perun" , "writable" : true , "baseFriendlyName" : "login-namespace" , "friendlyNameParameter" : "perun" , "unique" : false , "displayName" : "Login in namespace: perun" , "description" : "Logname in namespace 'perun'." , "id" : 1905 , "beanName" : "Attribute" } ] } } , {...} , {...} ] }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Invite member candidates to group. If candidate contains richUser, then his preferred mail is retrieved and used, otherwise email must be passed in candidate's attributes.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/inviteMemberCandidates

• see URL structure

Example params

{ "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "lang" : {...} , "candidates" : [ { "candidate" : { "id" : 0 , "serviceUser" : false , "firstName" : "Random" , "lastName" : "Name" , "middleName" : null , "titleBefore" : "Dr." , "titleAfter" : null , userExtSource : { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , additionalUserExtSources : null , attributes : { "urn:perun:member:attribute-def:def:organization" : "Masarykova univerzita" , "urn:perun:member:attribute-def:def:mail" : "random@name.cz" } } , "member" : { "id" : 12 , "userId" : 34 , "voId" : 42 , "sourceGroupId" : null , "membershipType" : "DIRECT" , "status" : "VALID" , "sponsored" : false , "beanName" : "Member" } , "richUser" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "RichUser" , "userExtSources" : [ { "userId": 34 , "loa" : 0 , "extSource" : { "name" : "PERUNPEOPLE" , "type" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "attributes" : {} , "id" : 2 , "beanName" : "ExtSource" } , "login" : "my_login" , "persistent" : true , "id" : 312 , "lastAccess" : "2019-06-10 14:07:42.2767" , "beanName" : "UserExtSource" } , {...} , {...} ], "userAttributes" : [ { "value" : "my_login" , "type" : "java.lang.String" , "entity" : "user" , "namespace" : "urn:perun:user:attribute-def:def" , "friendlyName" : "login-namespace:perun" , "writable" : true , "baseFriendlyName" : "login-namespace" , "friendlyNameParameter" : "perun" , "unique" : false , "displayName" : "Login in namespace: perun" , "description" : "Logname in namespace 'perun'." , "id" : 1905 , "beanName" : "Attribute" } ] } } , {...} , {...} ] , "group" : { "id" : 1061 , "name" : "My group" , "shortName" : "My group" , "description" : "My testing group" , "parentGroupId" : null , "voId" : 201 , "uuid" : "31e1014b-e994-4cb2-b238-e32aeef87670" , "beanName" : "Group" } }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Checks if invitation via notification is enabled (invitation notification exists, application form exists and application form can be submitted)

Example URL

https://[hostname]/krb/rpc/json/registrarManager/isInvitationEnabled

• see URL structure

Example params

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

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Checks if invitation via link is enabled (application form exists and application form can be submitted)

Example URL

https://[hostname]/krb/rpc/json/registrarManager/isLinkInvitationEnabled

• see URL structure

Example params

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

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Manually rejects an application. Expected to be called as a result of direct VO administrator action in the web UI.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/rejectApplication

• see URL structure

Example params

{ "id" : 97 }

• see Passing params

Example response

{ "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" }

• see Return values
• see HTTP return codes

Manually rejects an application with a reason. Expected to be called as a result of direct VO administrator action in the web UI.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/rejectApplication

• see URL structure

Example params

{ "id" : 89 , "reason" : "text" }

• see Passing params

Example response

{ "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" }

• see Return values
• see HTTP return codes

Manually rejects multiple applications at once. Expected to be called as a result of direct VO administrator action in the web UI.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/rejectApplications

• see URL structure

Example params

{ "ids" : [ 82 , 91 ] }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Manually rejects multiple applications at once with a reason. Expected to be called as a result of direct VO administrator action in the web UI.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/rejectApplications

• see URL structure

Example params

{ "ids" : [ 34 , 84 ] , "reason" : "text" }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Sends invitation email to user which is not member of VO

Example URL

https://[hostname]/krb/rpc/json/registrarManager/sendInvitation

• see URL structure

Example params

{ "userId" : 32 , "voId" : 43 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Sends invitation email to user which is not member of Group If user is not even member of VO, invitation link targets VO application form fist, after submission, Group application form is displayed.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/sendInvitation

• see URL structure

Example params

{ "userId" : 11 , "voId" : 41 , "groupId" : 19 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Sends invitation email to user which is not member of VO

Example URL

https://[hostname]/krb/rpc/json/registrarManager/sendInvitation

• see URL structure

Example params

{ "voId" : 44 , "name" : "text" , "email" : "text" , "language" : "text" }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Sends invitation email to user which is not member of VO and Group Invitation link targets VO application form fist, after submission, Group application form is displayed.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/sendInvitation

• see URL structure

Example params

{ "voId" : 53 , "groupId" : 6 , "name" : "text" , "email" : "text" , "language" : "text" }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Send invitations with link to VO / Group application form from provided csv data If VO or Group have non-empty attribute urn:perun:[vo/group]:attribute-def:def:applicationURL content is used as link to application form. Otherwise link is automatically generated based on required AUTHZ in template and registrar url set in /etc/perun/perun-registrar.properties. General errors result in exception being thrown, single failures are skipped and added to result used).

Example URL

https://[hostname]/krb/rpc/json/registrarManager/sendInvitationsFromCsv

• see URL structure

Example params

{ "invitationData" : ["mail@mail.cz", "mail2@mail.cz;user2"] , "voId" : 66 , "groupId" : 88 , "language" : "text" }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Re-send mail notification for existing application. Message of specified type is sent only, when application is in expected state related to the notification. Note, that some data related to processing application are not available (e.g. list of exceptions during approval), since this method doesn't perform any action with Application itself. Perun admin can send any notification except USER_INVITE type, see #sendInvitation() for this.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/sendMessage

• see URL structure

Example params

{ "mailType" : {...} , "appId" : 10 , "reason" : "text" }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Manually re-send multiple notifications at once. Expected to be called as a result of direct VO administrator action in the web UI.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/sendMessages

• see URL structure

Example params

{ "ids" : [ 75 , 82 ] }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Enable or disable sending for list of mail definitions.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/setSendingEnabled

• see URL structure

Example params

{ "mails" : {...} , "enabled" : true }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Creates a new application. The method triggers approval for VOs with auto-approved applications.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/submitApplication

• see URL structure

Example params

{ "app" : { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" } , "data" : [ { "id" : 12 , "forItem" : { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER",  "beanName" : "ApplicationFormItem" } , "shortName" : "form data name" , "value" : "test value" , "assuranceLevel" : "0" , "beanName" : "ApplicationFormItemData" } , {...} , {...} ] }

• see Passing params

Example response

{ "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" }

• see Return values
• see HTTP return codes

Updates an e-mail notification.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/updateApplicationMail

• see URL structure

Example params

{ "mail" : {...} }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Updates the form attributes, not the form items. - update automatic approval style - update module_names

Example URL

https://[hostname]/krb/rpc/json/registrarManager/updateForm

• see URL structure

Example params

{ "form" : { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "automaticApproval" : true , "automaticApprovalExtension" : true , "moduleClassName" : "cz.metacentrum.perun.core.impl.modules.attributes.VirtualAttributesModule" , "beanName" : "ApplicationForm" } }

• see Passing params

Example response

{ "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "automaticApproval" : true , "automaticApprovalExtension" : true , "moduleClassName" : "cz.metacentrum.perun.core.impl.modules.attributes.VirtualAttributesModule" , "beanName" : "ApplicationForm" }

• see Return values
• see HTTP return codes

Update data of specific application form item, which was originally submitted by the user. Only PerunAdmin can use this. Only applications in NEW or VERIFIED state can have form items updated. Form items of types: USERNAME, PASSWORD, HEADING, HTML_COMMENT, SUBMIT_BUTTON and AUTO_SUBMIT_BUTTON are not updatable by this method.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/updateFormItemData

• see URL structure

Example params

{ "appId" : 97 , "data" : { "id" : 12 , "forItem" : { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER",  "beanName" : "ApplicationFormItem" } , "shortName" : "form data name" , "value" : "test value" , "assuranceLevel" : "0" , "beanName" : "ApplicationFormItemData" } }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Update label, options, help and error message for specified form item and locale. FormItem is specified by its ID.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/updateFormItemTexts

• see URL structure

Example params

{ "formItem" : { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER",  "beanName" : "ApplicationFormItem" } , "locale" : "text" }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Replace label, options, help and error message for specified form item and all locales by current value. FormItem is specified by its ID.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/updateFormItemTexts

• see URL structure

Example params

{ "formItem" : { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER",  "beanName" : "ApplicationFormItem" } }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Updates form items sent in list.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/updateFormItems

• see URL structure

Example params

{ "vo" : 6 , "items" : [ { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER",  "beanName" : "ApplicationFormItem" } , {...} , {...} ] }

• see Passing params

Example response

88

• see Return values
• see HTTP return codes

Updates form items sent in list.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/updateFormItems

• see URL structure

Example params

{ "group" : 39 , "items" : [ { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER",  "beanName" : "ApplicationFormItem" } , {...} , {...} ] }

• see Passing params

Example response

97

• see Return values
• see HTTP return codes

Update data of application form items, which were originally submitted by the user. Only user who submitted the application can use this. Only applications in NEW or VERIFIED state can have form items updated. Form items of types: USERNAME, PASSWORD, HEADING, HTML_COMMENT, SUBMIT_BUTTON and AUTO_SUBMIT_BUTTON are not updatable by this method. If VALIDATED_EMAIL is changed to non-verified value, it will change application state from VERIFIED to NEW and trigger new verification and auto approval (if possible).

Example URL

https://[hostname]/krb/rpc/json/registrarManager/updateFormItemsData

• see URL structure

Example params

{ "appId" : 15 , "data" : [ { "id" : 12 , "forItem" : { "id" : 12 , "shortname" : "Form item name' , "required" : false , "updatable" : true , "type" : "CHECKBOX" , "federationAttribute" : "" , "perunSourceAttribute" : "PERUNPEOPLE" , "perunDestinationAttribute" : "", "regex" : "", "applicationTypes" : ["INITIAL" , "EXTENSION"], "ordnum" : 5, "hiddenDependencyItemId" : 5, "disabledDependencyItemId" : 5, "disabled" : "NEVER", "hidden" : "NEVER",  "beanName" : "ApplicationFormItem" } , "shortName" : "form data name" , "value" : "test value" , "assuranceLevel" : "0" , "beanName" : "ApplicationFormItemData" } , {...} , {...} ] }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Validates an email. This method should receive all URL parameters from a URL sent by an email to validate the email address that was provided by a user. The parameters describe the user, application, email and contain a message authentication code to prevent spoofing.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/validateEmail

• see URL structure

Example params

{ "m" : "text" , "i" : "text" }

• see Passing params

Example response

true

• see Return values
• see HTTP return codes

Forcefully marks application as verified (only when application was in NEW state)

Example URL

https://[hostname]/krb/rpc/json/registrarManager/verifyApplication

• see URL structure

Example params

{ "id" : 58 }

• see Passing params

Example response

{ "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "autoApproveError" : null , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : { "firstName" : "Some" , "lastName" : "Body" , "middleName" : null , "titleBefore" : "Mgr." , "titleAfter" : null , "serviceUser" : false , "sponsoredUser" : false , "specificUser" : false , "majorSpecificType" : "NORMAL" , "id" : 34 , "uuid" : "5e5a02dd-f991-4706-a428-69c3ea6c5ce8" , "beanName" : "User" }, "beanName" : "Application" }

• see Return values
• see HTTP return codes

Verify Captcha answer.

Example URL

https://[hostname]/krb/rpc/json/registrarManager/verifyCaptcha

• see URL structure

Example params

{ "response" : "text" }

• see Passing params

Example response

true

• see Return values
• see HTTP return codes