RPC API documentation v17.2.0

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

RegistrarManager

Add new mail notification.

Parameter nameData typeDescription
vointVO id
mailApplicationMailApplicationMail JSON object
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ApplicationMailIdint

Example URL

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

Example params

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

Example response

{ ... TODO ... }

Add new mail notification.

Parameter nameData typeDescription
groupintGroup id
mailApplicationMailApplicationMail JSON object
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ApplicationMailIdint

Example URL

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

Example params

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

Example response

{ ... TODO ... }

Adds a new item to a form.

Parameter nameData typeDescription
vointVO id
itemApplicationFormItemApplicationFormItem JSON object
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ApplicationFormItemAdded ApplicationFormItem object

Example URL

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

Example params

{ "vo" : 52 , "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" } }

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

Adds a new item to a form.

Parameter nameData typeDescription
groupintGroup id
itemApplicationFormItemApplicationFormItem JSON object
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ApplicationFormItemAdded ApplicationFormItem object

Example URL

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

Example params

{ "group" : 9 , "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" } }

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

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

Parameter nameData typeDescription
idsList<Integer>list of groups IDs
Thrown exceptionDescription
GroupNotAllowedToAutoRegistrationExceptionWhen given group cannot be added to auto registration
GroupNotExistsExceptionWhen the group doesn't exist
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

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

Example params

{ "ids" : [ 61 , 40 ] }

Example response

null

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

Parameter nameData typeDescription
idintApplication id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ApplicationApproved application

Example URL

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

Example params

{ "id" : 73 }

Example response

{ "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : , "beanName" : "Application" }

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.

Parameter nameData typeDescription
idintApplication id
Thrown exceptionDescription
CantBeApprovedExceptionWhen application can't be approved based on form module rules.
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

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

Example params

{ "id" : 70 }

Example response

null

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

Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<EnrichedIdentity>List of found similar identities.

Example URL

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

Example response

{ ... TODO ... }

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.

Parameter nameData typeDescription
appIdintid of application to check for
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Identity>List of found similar identities.

Example URL

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

Example params

{ "appId" : 29 }

Example response

{ ... TODO ... }

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.

Parameter nameData typeDescription
voIdintVo to get application for
groupIdintGroup to get application for
typeStringApplication type
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Identity>List of found similar identities.

Example URL

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

Example params

{ "voId" : 19 , "groupId" : 88 , "type" : "text" }

Example response

{ ... TODO ... }

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

Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Identity>List of found similar identities.

Example URL

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

Example response

{ ... TODO ... }

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.

Parameter nameData typeDescription
formItemsList<ApplicationFormItemData>List of application form items with data
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Identity>List of found similar identities.

Example URL

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

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

Example response

{ ... TODO ... }

Join user identities by access tokens.

Parameter nameData typeDescription
accessTokenaccesstoken
Thrown exceptionDescription
IdentitiesAlreadyJoinedExceptionBoth identities used in a process belong to the same user in Perun (already joined).
IdentityAlreadyInUseExceptionBoth identities used in a process are associated with different users. In order to join two user accounts contact support.
IdentityIsSameExceptionUser used same identity (authz) to get token and to request joining.
IdentityUnknownExceptionWhen neither current or previous identity is associated with a user in Perun.
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
InvalidTokenExceptionwhen some of the access token is expired
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

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

Example params

{ "accessToken" : {...} }

Example response

null

Join current user identity (authz) with the one previously provided and referenced by the token.

Parameter nameData typeDescription
tokenStringToken to be used for joining identities.
Thrown exceptionDescription
IdentitiesAlreadyJoinedExceptionBoth identities used in a process belong to the same user in Perun (already joined).
IdentityAlreadyInUseExceptionBoth identities used in a process are associated with different users. In order to join two user accounts contact support.
IdentityIsSameExceptionUser used same identity (authz) to get token and to request joining.
IdentityUnknownExceptionWhen neither current or previous identity is associated with a user in Perun.
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<UserExtSource>List of user identities know to Perun after joining.

Example URL

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

Example params

{ "token" : "text" }

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

Copy all form items from selected VO into another.

Parameter nameData typeDescription
fromVointSource VO id
toVointDestination VO id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ObjectAlways null

Example URL

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

Example params

{ "fromVo" : 58 , "toVo" : 8 }

Example response

{ ... TODO ... }

Copy all form items from selected Group into another.

Parameter nameData typeDescription
fromGroupintSource Group id
toGroupintDestination Group id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ObjectAlways null

Example URL

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

Example params

{ "fromGroup" : 49 , "toGroup" : 87 }

Example response

{ ... TODO ... }

Copy all form items from selected VO into Group.

Parameter nameData typeDescription
fromVOintSource VO id
toGroupintDestination Group id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ObjectAlways null

Example URL

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

Example params

{ "fromVO" : 5 , "toGroup" : 84 }

Example response

{ ... TODO ... }

Copy all form items from selected Group into VO.

Parameter nameData typeDescription
fromGroupintSource Group id
toVOintDestination VO id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ObjectAlways null

Example URL

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

Example params

{ "fromGroup" : 9 , "toVO" : 6 }

Example response

{ ... TODO ... }

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

Parameter nameData typeDescription
fromVointSource VO id
toVointDestination VO id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ObjectAlways null

Example URL

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

Example params

{ "fromVo" : 31 , "toVo" : 24 }

Example response

{ ... TODO ... }

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

Parameter nameData typeDescription
fromGroupintSource Group id
toGroupintDestination Group id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ObjectAlways null

Example URL

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

Example params

{ "fromGroup" : 9 , "toGroup" : 25 }

Example response

{ ... TODO ... }

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

Parameter nameData typeDescription
fromVointSource VO id
toGroupintDestination Group id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ObjectAlways null

Example URL

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

Example params

{ "fromVo" : 60 , "toGroup" : 90 }

Example response

{ ... TODO ... }

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

Parameter nameData typeDescription
fromGroupintSource Group id
toVOintDestination VO id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ObjectAlways null

Example URL

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

Example params

{ "fromGroup" : 66 , "toVO" : 71 }

Example response

{ ... TODO ... }

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

Parameter nameData typeDescription
appApplicationApplication JSON object
dataList<ApplicationFormItemData>List of ApplicationFormItemData JSON objects
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<ApplicationFormItemData>Stored app data

Example URL

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

Example params

{ "app" : { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "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" } , {...} , {...} ] }

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

Create application form for a VO.

Parameter nameData typeDescription
vointVO id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ObjectAlways returned null

Example URL

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

Example params

{ "vo" : 1 }

Example response

{ ... TODO ... }

Create application form for a group.

Parameter nameData typeDescription
groupintGroup id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ObjectAlways returned null

Example URL

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

Example params

{ "group" : 1 }

Example response

{ ... TODO ... }

Deletes an application.

Parameter nameData typeDescription
idintApplication id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

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

Example params

{ "id" : 2 }

Example response

null

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

Parameter nameData typeDescription
vointVO id
idintApplicationMail id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ObjectAlways null

Example URL

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

Example params

{ "vo" : 66 , "id" : 66 }

Example response

{ ... TODO ... }

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

Parameter nameData typeDescription
groupintGroup id
idintApplicationMail id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ObjectAlways null

Example URL

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

Example params

{ "group" : 31 , "id" : 24 }

Example response

{ ... TODO ... }

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.

Parameter nameData typeDescription
vointVO id
ordnumintItem's ordnum
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ObjectAlways null

Example URL

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

Example params

{ "vo" : 6 , "ordnum" : 47 }

Example response

{ ... TODO ... }

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.

Parameter nameData typeDescription
groupintGroup id
ordnumintItem's ordnum
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ObjectAlways null

Example URL

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

Example params

{ "group" : 95 , "ordnum" : 11 }

Example response

{ ... TODO ... }

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

Parameter nameData typeDescription
idsList<Integer>list of groups IDs
Thrown exceptionDescription
GroupNotExistsExceptionWhen the group doesn't exist
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

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

Example params

{ "ids" : [ 80 , 52 ] }

Example response

null

Returns application object by its id.

Parameter nameData typeDescription
idintApplication id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ApplicationFound application

Example URL

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

Example params

{ "id" : 4 }

Example response

{ "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : , "beanName" : "Application" }

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

Parameter nameData typeDescription
idintApplication id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<ApplicationFormItemData>Form data

Example URL

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

Example params

{ "id" : 91 }

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

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.

Parameter nameData typeDescription
vointVO id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ApplicationFormRegistration form description

Example URL

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

Example params

{ "vo" : 47 }

Example response

{ ... TODO ... }

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.

Parameter nameData typeDescription
groupintGroup id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ApplicationFormRegistration form description

Example URL

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

Example params

{ "group" : 74 }

Example response

{ ... TODO ... }

Return mail definition including texts by id.

Parameter nameData typeDescription
idintApplicationMail id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ApplicationMailApplicationMail object

Example URL

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

Example params

{ "id" : 68 }

Example response

{ ... TODO ... }

Returns all mail notifications related to specific app form.

Parameter nameData typeDescription
vointVO id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<ApplicationMail>Application mails

Example URL

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

Example params

{ "vo" : 0 }

Example response

{ ... TODO ... }

Returns all mail notifications related to specific app form.

Parameter nameData typeDescription
groupintGroup id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<ApplicationMail>Application mails

Example URL

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

Example params

{ "group" : 88 }

Example response

{ ... TODO ... }

Gets all applications for a given Group.

Parameter nameData typeDescription
groupintGroup id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Application>Found applications

Example URL

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

Example params

{ "group" : 16 }

Example response

[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : , "beanName" : "Application" } , {...} , {...} ]

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

Parameter nameData typeDescription
groupintGroup id
stateList<String>List of states: NEW, VERIFIED, APPROVED, REJECTED
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Application>Found applications

Example URL

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

Example params

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

Example response

[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : , "beanName" : "Application" } , {...} , {...} ]

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

Parameter nameData typeDescription
groupintGroup id
stateList<String>List of states: NEW, VERIFIED, APPROVED, REJECTED
dateFromLocalDateEarliest date for applications (format "YYYY-MM-DD")
dateToLocalDateLatest date for applications (format "YYYY-MM-DD")
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Application>Found applications

Example URL

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

Example params

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

Example response

[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : , "beanName" : "Application" } , {...} , {...} ]

Gets all applications for member

Parameter nameData typeDescription
memberintid of member to get applications for
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Application>Found applications

Example URL

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

Example params

{ "member" : 86 }

Example response

[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : , "beanName" : "Application" } , {...} , {...} ]

Gets all applications for member

Parameter nameData typeDescription
memberintid of member to get applications for
groupintid of group to filter applications for
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Application>Found applications

Example URL

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

Example params

{ "member" : 47 , "group" : 56 }

Example response

[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : , "beanName" : "Application" } , {...} , {...} ]

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

Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Application>Found applications

Example URL

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

Example response

[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : , "beanName" : "Application" } , {...} , {...} ]

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

Parameter nameData typeDescription
idintUser id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Application>Found applications

Example URL

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

Example params

{ "id" : 9 }

Example response

[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : , "beanName" : "Application" } , {...} , {...} ]

Gets all applications for a given VO.

Parameter nameData typeDescription
vointVO id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Application>Found applications

Example URL

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

Example params

{ "vo" : 10 }

Example response

[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : , "beanName" : "Application" } , {...} , {...} ]

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

Parameter nameData typeDescription
vointVO id
stateList<String>List of states: NEW, VERIFIED, APPROVED, REJECTED
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Application>Found applications

Example URL

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

Example params

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

Example response

[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : , "beanName" : "Application" } , {...} , {...} ]

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

Parameter nameData typeDescription
vointVO id
stateList<String>List of states: NEW, VERIFIED, APPROVED, REJECTED
dateFromLocalDateEarliest date for applications (format "YYYY-MM-DD")
dateToLocalDateLatest date for applications (format "YYYY-MM-DD")
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Application>Found applications

Example URL

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

Example params

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

Example response

[ { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : , "beanName" : "Application" } , {...} , {...} ]

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.

Parameter nameData typeDescription
vointVo id
queryApplicationsPageQueryQuery with page information
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PerunException
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
PrivilegeExceptionif user doesnt have sufficient privileges
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoNotExistsExceptionif there is no such vo
Return typeDescription
Paginated<RichApplication>page of requested rich applications

Example URL

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

Example params

{ "vo" : 31 , "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 } }

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" , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : , "beanName" : "RichApplication", "formData" :  } , {...} , {...} ]  }

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.

Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
StringToken to be used for joining identities.

Example URL

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

Example response

"text"

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

Parameter nameData typeDescription
idintID of application form item
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

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

Example params

{ "id" : 2 }

Example response

null

Gets all items in VO application form.

Parameter nameData typeDescription
vointVO id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<ApplicationFormItem>All form items regardless of type

Example URL

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

Example params

{ "vo" : 84 }

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

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

Parameter nameData typeDescription
vointVO id
typeStringApplication type: INITIAL or EXTENSION
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<ApplicationFormItem>Items of specified type

Example URL

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

Example params

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

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

Gets all items in Group application form.

Parameter nameData typeDescription
groupintGroup id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<ApplicationFormItem>All form items regardless of type

Example URL

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

Example params

{ "group" : 93 }

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

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

Parameter nameData typeDescription
groupintGroup id
typeStringApplication type: INITIAL, EXTENSION or EMBEDDED
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<ApplicationFormItem>Items of specified type

Example URL

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

Example params

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

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

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.

Parameter nameData typeDescription
vointVO id
typeStringApplication type: INITIAL or EXTENSION
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<ApplicationFormItemWithPrefilledValue>Form items

Example URL

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

Example params

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

Example response

{ ... TODO ... }

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.

Parameter nameData typeDescription
groupintGroup id
typeStringApplication type: INITIAL, EXTENSION or EMBEDDED
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<ApplicationFormItemWithPrefilledValue>Form items

Example URL

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

Example params

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

Example response

{ ... TODO ... }

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

Parameter nameData typeDescription
vointvo id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
VoNotExistsExceptionWhen the vo doesn't exist
Return typeDescription
List<Group>list of groups

Example URL

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

Example params

{ "vo" : 24 }

Example response

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

Retrieves all necessary data about VO under registrar session.

Parameter nameData typeDescription
voShortNameStringVO's shortname to get info about
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Attribute>List of VO attributes

Example URL

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

Example params

{ "voShortName" : "text" }

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

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

Parameter nameData typeDescription
voShortNameStringVO's shortname to get info about
groupNameStringGroup's full name (including groups structure) to get info about
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
List<Attribute>List of VO attributes

Example URL

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

Example params

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

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

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

Parameter nameData typeDescription
idintApplication id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ApplicationRejected application

Example URL

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

Example params

{ "id" : 94 }

Example response

{ "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : , "beanName" : "Application" }

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

Parameter nameData typeDescription
idintApplication id
reasonStringReason description
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ApplicationRejected application

Example URL

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

Example params

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

Example response

{ "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : , "beanName" : "Application" }

Sends invitation email to user which is not member of VO

Parameter nameData typeDescription
userIdintid of user to send invitation to
voIdintid of VO to send invitation into
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

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

Example params

{ "userId" : 65 , "voId" : 67 }

Example response

null

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.

Parameter nameData typeDescription
userIdintid of user to send invitation to
voIdintid of VO to send invitation into
groupIdintid of Group to send invitation into
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

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

Example params

{ "userId" : 25 , "voId" : 22 , "groupId" : 46 }

Example response

null

Sends invitation email to user which is not member of VO

Parameter nameData typeDescription
voIdintid of VO to send invitation into
nameStringname of person used in invitation email (optional)
emailStringemail address to send invitation to
languageStringpreferred language to use
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

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

Example params

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

Example response

null

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.

Parameter nameData typeDescription
voIdintid of VO to send invitation into
groupIdintid of Group to send invitation into
nameStringname of person used in invitation email (optional)
emailStringemail address to send invitation to
languageStringpreferred language to use
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

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

Example params

{ "voId" : 16 , "groupId" : 67 , "name" : "text" , "email" : "text" , "language" : "text" }

Example response

null

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.

Parameter nameData typeDescription
mailTypeMailTypetype of mail notification
appIdintid of application to send notification for
reasonStringyou can specify reason for case: mailType == APP_REJECTED_USER
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
sRegistrarException if notification can't be sent
Return typeDescription
void

Example URL

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

Example params

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

Example response

null

Enable or disable sending for list of mail definitions.

Parameter nameData typeDescription
mailsList<ApplicationMail>Mail definitions to update
enabledbooleantrue for enabled, false for disabled
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ObjectAlways null

Example URL

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

Example params

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

Example response

{ ... TODO ... }

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

Parameter nameData typeDescription
appApplicationApplication JSON object
dataList<ApplicationFormItemData>List of ApplicationFormItemData JSON objects
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ApplicationSubmitted application

Example URL

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

Example params

{ "app" : { "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "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" } , {...} , {...} ] }

Example response

{ "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : , "beanName" : "Application" }

Updates an e-mail notification.

Parameter nameData typeDescription
mailApplicationMailApplicationMail JSON object
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ObjectAlways null

Example URL

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

Example params

{ "mail" : {...} }

Example response

{ ... TODO ... }

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

Parameter nameData typeDescription
formApplicationFormApplication form JSON object
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ApplicationFormUpdated application form or null when update failed

Example URL

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

Example params

{ "form" : {...} }

Example response

{ ... TODO ... }

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.

Parameter nameData typeDescription
appIdintID of Application this data belongs to.
dataApplicationFormItemDataForm item data to be updated by its ID.
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

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

Example params

{ "appId" : 32 , "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" } }

Example response

null

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

Parameter nameData typeDescription
formItemApplicationFormItemForm item to update
localeStringLocale specified like: cs, en, ...
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

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

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

Example response

null

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

Parameter nameData typeDescription
formItemApplicationFormItemForm item to update
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

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

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

Example response

null

Updates form items sent in list.

Parameter nameData typeDescription
vointVO id
itemsList<ApplicationFormItem>Application form items
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
intNumber of updated items

Example URL

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

Example params

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

Example response

64

Updates form items sent in list.

Parameter nameData typeDescription
groupintGroup id
itemsList<ApplicationFormItem>Application form items
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
intNumber of updated items

Example URL

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

Example params

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

Example response

84

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

Parameter nameData typeDescription
appIdintID of Application this data belongs to.
dataList<ApplicationFormItemData>Form items data to be updated by their IDs.
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
void

Example URL

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

Example params

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

Example response

null

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.

Parameter nameData typeDescription
mStringParameter m
iStringParameter i
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
booleanTrue for validated, false for non-valid

Example URL

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

Example params

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

Example response

true

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

Parameter nameData typeDescription
idintApplication id
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
ApplicationVerified application

Example URL

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

Example params

{ "id" : 20 }

Example response

{ "id" : 12 , "vo" : { "id" : 123 , "name" : "My testing VO" , "shortName" : "test_vo" , "beanName" : "Vo" } , "type" : "INITIAL" , "fedInfo" : "" , "state" : "NEW" , "extSourceName" : "PERUNPEOPLE" , "extSourceType" : "cz.metacentrum.perun.core.impl.ExtSourceSql" , "user" : , "beanName" : "Application" }

Verify Captcha answer.

Parameter nameData typeDescription
responseStringUser response
Thrown exceptionDescription
InternalErrorExceptionWhen unspecified error occur. See exception param message for explanation.
PrivilegeExceptionWhen caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values.
RpcExceptionWrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation.
Return typeDescription
booleanTrue if it is valid, False if failed

Example URL

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

Example params

{ "response" : "text" }

Example response

true